&& Markup Structures used for the Booklets ------------------------------------------: This document indicates some of the textual markup structures which are used in the books in these folders. These markup codes or structures are designed to allow the books to be rendered into a variety of formats such as html, latex, pdf, etc. These text structures were chosen by me purely on the grounds of that which does not interfere with my own reading and editing of the text document. quote: "..." should become quotations section headings are all in capitals like this: A SECTION HEADING sub-section heading are all capitals and followed by 4 dots A SUBSECTION HEADING .... a sub-sub-section heading is the same but followed by 8 dots A SUBSUBSECTION HEADING ........ Lists of weblinks are marked up as follows ------------------------------------------ @@ google.com a search engine @@ bumble.sf.net A site with some attempts to write booklets in plain text which can be transformed to pdf @@ ctan.org the tex archive site These lists must be terminated by a blank line Lists of long definitions are marked up as follows -------------------------------------------------- =: title of the list @@ term long description @@ term long description These lists must also be terminated by a blank line Enumerated lists are written as follows --------------------------------------- 00- the first item - the second item - the 3rd These lists are terminated by a blank line Tables of 2 column data or markup as follows -------------------------------------------- == the title .. man - unix manual page .. ls - list files .. pwd - print the current working folder These tables must be terminated with a blank line. A comma ',' can also be used to separate the two fields (instead of ' - ') for example: .. man, unix manual pages. Lines beginning with hashes '#' should be rendered at notes which are important. Paragraphs which have a '+' at the top are not very important and may be omitted in a final document recipes start with '*' and the recipe code line starts with '>>' An example of a recipe and its description is * show how many lines start with the '#' character >> grep '^ *#' file | wc -l In, or after recipe lines the string '##(' and )' are for writing comments For example: >> grep '#' file | wc -l ##(this is a comment about the code) Long recipes start with '*', and end with ',,,' on a line by itself, but I havent quite finalized this format (this may change) An example of a long recipe: * make all files equal ---------------------- ... ,,,