old-www/HOWTO/Linuxdoc-Reference-12.html

46 lines
1.4 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="SGML-Tools 1.0.9">
<TITLE>Linuxdoc Reference: Literate Programming</TITLE>
<LINK HREF="Linuxdoc-Reference-13.html" REL=next>
<LINK HREF="Linuxdoc-Reference-11.html" REL=previous>
<LINK HREF="Linuxdoc-Reference.html#toc12" REL=contents>
</HEAD>
<BODY>
<A HREF="Linuxdoc-Reference-13.html">Next</A>
<A HREF="Linuxdoc-Reference-11.html">Previous</A>
<A HREF="Linuxdoc-Reference.html#toc12">Contents</A>
<HR>
<H2><A NAME="litprog"></A> <A NAME="s12">12. Literate Programming</A></H2>
<P>
<HR>
<PRE>
&lt;!entity % litprog " code | verb " >
</PRE>
<HR>
This one is a funny thing.
It's the idea of not to write some comment text within a program,
and might be to take later some special tools, to extract
the text
<BLOCKQUOTE>Think of <CODE>perlpod</CODE>.</BLOCKQUOTE>
, but to write a big
document and later to extract the code from it.
<BLOCKQUOTE>People who don't like to document their code will not appreciate.</BLOCKQUOTE>
The principle is:
All text within <CODE>verb</CODE> and <CODE>code</CODE> tags, will be gathered into a
sourcefile.
<P>
<P>That's it, because for now I don't remember the name of the tool doing thatone.
<P>
<P>
<HR>
<A HREF="Linuxdoc-Reference-13.html">Next</A>
<A HREF="Linuxdoc-Reference-11.html">Previous</A>
<A HREF="Linuxdoc-Reference.html#toc12">Contents</A>
</BODY>
</HTML>