| < Collaborative work on a HelpSetMaker project | Title, author, headlines, subheaders, text and paragraphs > |
HelpSetMaker features an own markup language for editing the help texts: The “Simple Text Markup Language”, STML. Its purpose is to allow fast and convenient editing of help texts by persons not familiar with strictly structured command languages. The approach is comparable to applications like Wikis, Blogs or CMS': Text is typed more or less like on a typewriter, and an engine translates this to HTML by applying some straightforward rules.
Help texts usually have a rather strict structure: You have titled sections, perhaps with subtitles. Paragraphes are rather short and quite often accompanied by graphics or pictures. Normally, the information is further structured into numbered or unnumbered lists which even can be stacked. Finally, links to other parts of the current page, other pages, and perhaps other resources outside the helpset are included. STML supports all these means of content.
The following description of the STML command language features lots of examples on how to write certain elements of the language. Note that the STML source code to produce the examples is, of course, a little bit complicated. Perhaps you should not start learning STML by following the STML source of this documentation but through writing your own code guided by the examples.
| < Collaborative work on a HelpSetMaker project | Title, author, headlines, subheaders, text and paragraphs > |