gdritter repos telml / c9d0b52
Added brief, bad README Getty Ritter 9 years ago
1 changed file(s) with 46 addition(s) and 0 deletion(s). Collapse all Expand all
+46
-0
README.md less more
1 # TeLML
2
3 A Tex-Like Markup Language—which is a bit of a misnomer, because
4 as presented, it's more of a structured data language than a
5 markup language. A _TeLML Document_ is a sequence of textual
6 fragments interspersed with "tags", which have the format
7
8 ~~~~
9 \tagname{ document | document | ... }
10 ~~~~
11
12 Whitespace is _not_ allowed between the backslash and the tag
13 name, but _is_ allowed between the tag name and the following
14 block. In contrast to LaTeX, the block is _obligatory_, i.e.
15 the following is not a valid document:
16
17 ~~~~
18 \p{this \br and that}
19 ~~~~
20
21 Whereas this is:
22
23 ~~~~
24 \p{this \br{} and that}
25 ~~~~
26
27 (This restriction might at some point be lifted based on experience
28 with the format.)
29
30 The intended use for TeLML is as a building-block for specific
31 markup formats in which you might want to have arbitrary new
32 tags, but don't want to use an XML-based solution.
33
34 # Possible Future Modifications
35
36 Variations on this theme that might be possible:
37
38 - It might (as stated above) be worthwhile to attempt to lift the
39 restriction that every tag has an argument block, if nullary
40 tags are commonly used.
41 - It might be nice to optionally allow `\begin{...}` and `\end{...}`
42 tags to be parsed as a special case of certain delimiters.
43 - Maybe a special case for named arguments of the form
44 `\tag{arg=stuff|arg=stuff}`, although this could be
45 handled at present by using nested tags as in
46 `\tag{\arg{stuff}|\arg{stuff}}`.