nfoWare Hard Hat Stage

n131101 nfoWare nfoNote
Literate UpDown

nfoWare>notes>
2013>11>

n131101>
0.01 2017-06-03 15:07 -0700


Literate UpDown is an application of UpDown markup intended to support a form of Literate Programming. 

The basic idea is that Literate UpDown is readable in its own right as a text file and can serve as an active document, in that it can be operated in various ways.  The Literate UpDown file could also be employed in a rich viewer or rich text editor for more convenient presentation.  There should be straightforward translation to web page(s).

Another use of Literate UpDown is as markup within the source code of a computer program.  This raises some peculiar problems if redundancy with structures already visible in the code is to be avoided.  That means the code is being annotated and that makes extraction of a document above the code more problematic.

The principle design point is that programmers should be able to begin producing Literate UpDown starting with familiar structures in code, and that collaborative development of open-source projects could employ Literate UpDown without creating barriers to entry for participants or excessive friction for developers.  In that respect, some of the motivations of noweb are applicable.

A second design point is having a means to accomplish Systematic Program Design using programming languages such as C/C++ and Java, even though the edit-compile-execute cycle is longer.

It seems very easy to re-invent the wheel and also arrive at a duplicative dead end.  To counter that, there will be an effort to avoid premature generalization and use versioning and care to work from the least that can possibly work.

More Information


Attribution:
Hamilton, Dennis E.
Literate UpDown.   nfoWare nfoNote folio n131101 0.01, November 11, 2013.  Accessed at <http://nfoWare.com/notes/2013/11/n131101.htm>.
Revision History:
0.01 2013-11-11-10:30 Initial Sketch
The investigation stage is summarized.
0.00 2013-11-08-14:06 Establish Placeholder for Pending Material
This folio is cloned from a close-enough version in Toolcraft.  The placeholder observes the style and formatting of the current repaving approach.

Construction Structure  (Hard Hat Area)

Creative Commons License You are navigating nfoWare.
This work is licensed under a
Creative Commons Attribution 2.5 License.

created 2013-11-08-14:06 -0800 (pst) by orcmid
$$Author: Orcmid $
$$Date: 17-06-03 15:07 $
$$Revision: 85 $