Added simple README

snm_help/abuse.yaml

@@ -10,4 +10,8 @@ text:
    - "If you use snm and need more help than is available in this manual then do not hesitate to contact the author at spoon@killersmurf.com."
    - "Please note that snm suffers from a number of shortfalls:"
    - "Invalid xhtml can be generated through manipulation of the {section style sheet style}, {section literal text literal}, {section link destinations links}, and the {section unique names of sections sections}."
-   - "While I regret that this is possible, attempting xhtml kludges through these means ill-fitting means is misuse of snm and may result in generation shoddy manuals, a telling off and early bed-times all around.  You have been warned!"
+   - "While I regret that this is possible, attempting xhtml kludges through these means ill-fitting means is misuse of snm and may result in generation of shoddy manuals, a telling off and early bed-times all around.  You have been warned!"
+   - "Other problems:"
+   - "snm will not check that your section links actually point anywhere."
+   - "section numbering is difficult at the moment."
+   - "Track these issues at the {external repository http://github.com/elginer/snm}"

snm_help/how/inline.yaml

@@ -10,4 +10,4 @@ text:
    - "Inline elements within paragraphs and banners allow more expressive text.  The idea of an inline snm element is roughly equivalent to an inline HTML element.  Much as an xhtml anchor can only appear within an xhtml block element, an inline element can only appear within an snm paragraph or banner."
    - "Inline elements appear within curly braces \{ }."
    - "If you need to actually write an opening brace in your document, the opening brace may be escaped with a backslash \."
-   - "The following inline elements are available: section links, external links, inline classes, inline languages and literal text."
+   - "The following inline elements are available: {section section links links}, {section external links links}, {section inline classes inlineclass}, {section inline syntax highlighting inlinesyntax} and {section literal text literal}."

snm_help/how/inline/syntax.yaml

@@ -0,0 +1,18 @@
+# Copyright John Morrice 2010
+# This document is part of The Simple Nice-Looking Manual Generator documentation
+# This document is released under the terms of the GNU Free Documentation Licence
+# See the file DOC-COPYING.
+title: Inline Syntax Highlighting
+number: 4
+unique: inlinesyntax
+text:
+   - "snm supports inline {section syntax highlighting syntax} through {class language example} inline elements.  An example:"
+   - class: example
+     wrap: False
+     text: "   Some logic:\{language forall E. A subset B. E member A implies E member B math}"
+   - "This is rendered as:"
+   - class: example
+     wrap: False
+     text: "   Some logic:{language forall E. A subset B. E member A implies E member B math}"
+
+

snm_help/how/paragraphs.yaml

@@ -50,11 +50,11 @@ text:
    - wrap: False
      class: example
      text: "   language: math
-          \n   text: \"forall A forsome B [A memberof C B memberof C . A + B ]\""
+          \n   text: \"forall A. A !member empty\""
    - "Is rendered as:"
    - language: math
      wrap: False
-     text: "   forall A forsome B [A memberof C B memberof C . A + B ]"
+     text: "   forall A. A !member empty"
 
 
 

snm_help/how/syntax.yaml

@@ -20,3 +20,11 @@ text:
    - "snm provides a module {class Text.Syntax.Simple example} which makes it easy to write keyword-oriented syntax highlighters."
    - "Be aware that snm will not html escape strings returned by the syntax highlighter.  {class Text.XHtml.Strict.stringToHtmlString example} from the {external xhtml package http://hackage.haskell.org/package/xhtml} may be useful."
    - "As an example, here is this document's syntax.yaml:"
+   - class: example
+     wrap: False
+     text:
+        "   language: math
+       \n   package: snmmath-0.0.1
+       \n   module: Text.Syntax.Math
+       \n   symbol: math"
+   - "{external snmmath is hosted on github, too http://github.com/elginer/snm_math}."

snm_help/syntax.yaml

@@ -0,0 +1,9 @@
+# Copyright John Morrice 2010
+# This document is part of The Obelisk Programming Language documentation
+# This document is released under the terms of the GNU Free Documentation Licence
+# See the file DOC-COPYING.
+
+language: math
+package: snmmath-0.0.1
+module: Text.Syntax.Math
+symbol: math