## "Fossies" - the Fresh Open Source Software Archive

### Source code changes of the file "TeXmacs/doc/devel/format/basics/tm-tm.en.tm" betweenTeXmacs-1.99.4-src.tar.gz and TeXmacs-1.99.5-src.tar.gz

About: GNU TeXmacs is a what-you-see-is-what-you-get scientific text editor, which was both inspired by TeX and GNU Emacs.

tm-tm.en.tm  (TeXmacs-1.99.4-src):tm-tm.en.tm  (TeXmacs-1.99.5-src)
<TeXmacs|1.> <TeXmacs|1.99.4>
<style|> <style|<tuple|tmdoc|english>>
<\body> <\body>
<tmdoc-title|Default serialization> <tmdoc-title|Default serialization>
Documents are generally written to disk using the standard <TeXmacs> syntax Documents are generally written to disk using the standard <TeXmacs> syntax
(which corresponds to the <verbatim|.tm> and <verbatim|.ts> file (which corresponds to the <verbatim|.tm> and <verbatim|.ts> file
extensions). This syntax is designed to be unobtrusive and easy to read, so extensions). This syntax is designed to be unobtrusive and easy to read, so
the content of a document can be easily understood from a plain text the content of a document can be easily understood from a plain text
editor. For instance, the formula (<reference|tm-tree-ex>) is represented editor. For instance, the formula (<reference|tm-tree-ex>) is represented
by by
skipping to change at line 41 skipping to change at line 41
<\equation> <\equation>
<label|gen-tree-tm><tree|f|x<rsub|1>|\<cdots\>|x<rsub|n>> <label|gen-tree-tm><tree|f|x<rsub|1>|\<cdots\>|x<rsub|n>>
</equation> </equation>
is serialized as is serialized as
<\tm-fragment> <\tm-fragment>
<verbatim|\<less\>f\|x<rsub|1>\|...\|x<rsub|n>\<gtr\>> <verbatim|\<less\>f\|x<rsub|1>\|...\|x<rsub|n>\<gtr\>>
</tm-fragment> </tm-fragment>
If one of the arguments <math|x<rsub|1>,\<ldots\>,x<rsub|n>> is a If one of the arguments <math|x<rsub|1>,\<ldots\>,x<rsub|n>> is a
multi-paragraph tree (which means in this context that it contains a multi-paragraph tree (which means in this context that it contains a
<markup|document> tag or a <markup|collection> tag), then an alternative <markup|document> tag or a <markup|collection> tag), then an alternative
long form is used for the serialization. If <verbatim|f> takes only long form is used for the serialization. If <verbatim|f> takes only
multi-paragraph arguments, then the tree would be serialized as multi-paragraph arguments, then the tree would be serialized as
<\tm-fragment> <\tm-fragment>
<\verbatim>
<\verbatim> \<less\>\\f\<gtr\>
\<less\>\\f\<gtr\>
\ \ x<rsub|1> \ \ x<rsub|1>
\<less\>\|f\<gtr\> \<less\>\|f\<gtr\>
\ \ ... \ \ ...
\<less\>\|f\<gtr\> \<less\>\|f\<gtr\>
\ \ x<rsub|n> \ \ x<rsub|n>
\<less\>/f\<gtr\> \<less\>/f\<gtr\>
</verbatim> </verbatim>
</tm-fragment> </tm-fragment>
In general, arguments which are not multi-paragraph are serialized using In general, arguments which are not multi-paragraph are serialized using
the short form. For instance, if <verbatim|n=5> and <verbatim|x<rsub|3>> the short form. For instance, if <verbatim|n=5> and <verbatim|x<rsub|3>>
and <verbatim|x<rsub|5>> are multi-paragraph, but not <verbatim|x<rsub|1>,> and <verbatim|x<rsub|5>> are multi-paragraph, but not <verbatim|x<rsub|1>,>
<verbatim|x<rsub|2>> and <verbatim|x<rsub|4>>, then <verbatim|x<rsub|2>> and <verbatim|x<rsub|4>>, then
(<reference|gen-tree-tm>) is serialized as (<reference|gen-tree-tm>) is serialized as
<\tm-fragment> <\tm-fragment>
<\verbatim>
<\verbatim> \<less\>\\f\|x<rsub|1>\|x<rsub|2>\<gtr\>
\<less\>\\f\|x<rsub|1>\|x<rsub|2>\<gtr\>
\ \ x<rsub|3> \ \ x<rsub|3>
\<less\>\|f\|x<rsub|4>\<gtr\> \<less\>\|f\|x<rsub|4>\<gtr\>
\ \ x<rsub|5> \ \ x<rsub|5>
\<less\>/f\<gtr\> \<less\>/f\<gtr\>
</verbatim> </verbatim>
</tm-fragment> </tm-fragment>
The escape sequences <verbatim|\\\|>, The escape sequences <verbatim|\\\<less\>less\\\<gtr\>>, <verbatim|\\\|>,
and <verbatim|\\\\> may be used to represent the <verbatim|\\\<less\>gtr\\\<gtr\>> and <verbatim|\\\\> may be used to
characters <verbatim|\<less\>>, <verbatim|\|>, <verbatim|\<gtr\>> and represent the characters <verbatim|\<less\>>, <verbatim|\|>,
<verbatim|\\>. For instance, is <verbatim|\<gtr\>> and <verbatim|\\>. For instance,
serialized as <verbatim|\\\<less\>alpha\\\<gtr\>+\\\<less\>beta\\\<gtr\>>. <math|\<alpha\>+\<beta\>> is serialized as
<verbatim|\\\<less\>alpha\\\<gtr\>+\\\<less\>beta\\\<gtr\>>.
<paragraph*|Formatting and whitespace> <paragraph*|Formatting and whitespace>
The <markup|document> and <markup|concat> primitives are serialized in a The <markup|document> and <markup|concat> primitives are serialized in a
special way. The <markup|concat> primitive is serialized as usual special way. The <markup|concat> primitive is serialized as usual
concatenation. For instance, the text is concatenation. For instance, the text \Pan <em|important> note\Q is
serialized as serialized as
<\tm-fragment> <\tm-fragment>
<\verbatim>
<\verbatim> an \<less\>em\|important\<gtr\> note
an \<less\>em\|important\<gtr\> note </verbatim>
</verbatim>
</tm-fragment> </tm-fragment>
The <markup|document> tag is serialized by separating successive paragraphs The <markup|document> tag is serialized by separating successive paragraphs
by double newline characters. For instance, the quotation by double newline characters. For instance, the quotation
<\quote-env> <\quote-env>
Ik ben de blauwbilgorgel. Ik ben de blauwbilgorgel.
Als ik niet wok of worgel, Als ik niet wok of worgel,
</quote-env> </quote-env>
is serialized as is serialized as
<\tm-fragment> <\tm-fragment>
<\verbatim>
<\verbatim> \<less\>\\quote-env\<gtr\>
\<less\>\\quote-env\<gtr\>
\ \ Ik ben de blauwbilgorgel. \ \ Ik ben de blauwbilgorgel.
\; \;
\ \ Als ik niet wok of worgel, \ \ Als ik niet wok of worgel,
\<less\>/quote-env\<gtr\> \<less\>/quote-env\<gtr\>
</verbatim> </verbatim>
</tm-fragment> </tm-fragment>
Notice that whitespace at the beginning and end of paragraphs is ignored. Notice that whitespace at the beginning and end of paragraphs is ignored.
Inside paragraphs, any amount of whitespace is considered as a single Inside paragraphs, any amount of whitespace is considered as a single
space. Similarly, more than two newline characters are equivalent to two space. Similarly, more than two newline characters are equivalent to two
newline characters. For instance, the quotation might have been stored on newline characters. For instance, the quotation might have been stored on
disk as disk as
<\tm-fragment> <\tm-fragment>
<\verbatim>
<\verbatim> \<less\>\\quote-env\<gtr\>
\<less\>\\quote-env\<gtr\>
\ \ Ik ben de \ \ \ \ \ \ \ \ \ \ blauwbilgorgel. \ \ Ik ben de \ \ \ \ \ \ \ \ \ \ blauwbilgorgel.
\; \;
\; \;
\ \ Als ik niet wok of \ \ \ \ \ \ \ \ \ worgel, \ \ Als ik niet wok of \ \ \ \ \ \ \ \ \ worgel,
\<less\>/quote-env\<gtr\> \<less\>/quote-env\<gtr\>
</verbatim> </verbatim>
</tm-fragment> </tm-fragment>
The space character may be explicitly represented through the escape The space character may be explicitly represented through the escape
sequence Empty paragraphs are represented using the sequence \P<verbatim|\\ >\Q. Empty paragraphs are represented using the
escape sequence escape sequence \P<verbatim|\\;>\Q.
<paragraph*|Raw data> <paragraph*|Raw data>
The <markup|raw-data> primitive is used inside <TeXmacs> for the The <markup|raw-data> primitive is used inside <TeXmacs> for the
representation of binary data, like image files included into the document. representation of binary data, like image files included into the document.
Such binary data is serialized as Such binary data is serialized as
<\tm-fragment> <\tm-fragment>
<\verbatim>
<\verbatim> \<less\>#<em|binary-data>\<gtr\>
\<less\>#<em|binary-data>\<gtr\> </verbatim>
</verbatim>
</tm-fragment> </tm-fragment>
where the <verbatim|<em|binary-data>> is a string of hexadecimal numbers where the <verbatim|<em|binary-data>> is a string of hexadecimal numbers
which represents a string of bytes. which represents a string of bytes.