1
0
Fork 0

DOC_EN: correct escape sequence for < and >

This commit is contained in:
Darcy Shen 2016-02-19 10:15:03 +00:00
parent c2eb4a101d
commit f75d047944
1 changed files with 52 additions and 66 deletions

View File

@ -1,6 +1,6 @@
<TeXmacs|1.0.3.10> <TeXmacs|1.99.4>
<style|tmdoc> <style|<tuple|tmdoc|english>>
<\body> <\body>
<tmdoc-title|Default serialization> <tmdoc-title|Default serialization>
@ -38,30 +38,28 @@
<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 <with|mode|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>
<\with|par-par-sep|0fn> <\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>
</with>
</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
@ -71,40 +69,37 @@
(<reference|gen-tree-tm>) is serialized as (<reference|gen-tree-tm>) is serialized as
<\tm-fragment> <\tm-fragment>
<\with|par-par-sep|0fn> <\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>
</with>
</tm-fragment> </tm-fragment>
The escape sequences <verbatim|\\\<less\>>, <verbatim|\\\|>, The escape sequences <verbatim|\\\<less\>less\\\<gtr\>>, <verbatim|\\\|>,
<verbatim|\\\<gtr\>> 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, <with|mode|math|\<alpha\>+\<beta\>> 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 ``an <em|important> note'' is concatenation. For instance, the text \Pan <em|important> note\Q is
serialized as serialized as
<\tm-fragment> <\tm-fragment>
<\with|par-par-sep|0fn> <\verbatim>
<\verbatim> an \<less\>em\|important\<gtr\> note
an \<less\>em\|important\<gtr\> note </verbatim>
</verbatim>
</with>
</tm-fragment> </tm-fragment>
The <markup|document> tag is serialized by separating successive paragraphs The <markup|document> tag is serialized by separating successive paragraphs
@ -119,19 +114,17 @@
is serialized as is serialized as
<\tm-fragment> <\tm-fragment>
<\with|par-par-sep|0fn> <\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>
</with>
</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.
@ -141,26 +134,24 @@
disk as disk as
<\tm-fragment> <\tm-fragment>
<\with|par-par-sep|0fn> <\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>
</with>
</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 ``<verbatim|\\ >''. Empty paragraphs are represented using the sequence \P<verbatim|\\ >\Q. Empty paragraphs are represented using the
escape sequence ``<verbatim|\\;>''. escape sequence \P<verbatim|\\;>\Q.
<paragraph*|Raw data> <paragraph*|Raw data>
@ -169,17 +160,15 @@
Such binary data is serialized as Such binary data is serialized as
<\tm-fragment> <\tm-fragment>
<\with|par-par-sep|0fn> <\verbatim>
<\verbatim> \<less\>#<em|binary-data>\<gtr\>
\<less\>#<em|binary-data>\<gtr\> </verbatim>
</verbatim>
</with>
</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.
<tmdoc-copyright|2004|Joris van der Hoeven> <tmdoc-copyright|2016|Joris van der Hoeven>
<tmdoc-license|Permission is granted to copy, distribute and/or modify this <tmdoc-license|Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License, Version 1.1 document under the terms of the GNU Free Documentation License, Version 1.1
@ -189,8 +178,5 @@
Documentation License".> Documentation License".>
</body> </body>
<\initial> <initial|<\collection>
<\collection> </collection>>
<associate|language|english>
</collection>
</initial>