YAM minimal test file.
1. YAM Syntax
1.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
1.2. Contents
Contents listings like that above are generated by '%contents'
1.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
1.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
1.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
1.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
1.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:1.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
1.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
1.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
1.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
1.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
1.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
1.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
1.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
1.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
1.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
YAM minimal test file.2. YAM Syntax
2.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
2.2. Contents
Contents listings like that above are generated by '%contents'
2.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
2.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
2.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
2.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
2.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:2.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
2.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
2.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
2.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
2.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
2.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
2.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
2.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
2.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
2.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
YAM minimal test file.3. YAM Syntax
3.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
3.2. Contents
Contents listings like that above are generated by '%contents'
3.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
3.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
3.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
3.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
3.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:3.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
3.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
3.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
3.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
3.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
3.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
3.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
3.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
3.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
3.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
YAM minimal test file.4. YAM Syntax
4.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
4.2. Contents
Contents listings like that above are generated by '%contents'
4.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
4.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
4.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
4.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
4.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:4.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
4.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
4.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
4.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
4.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
4.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
4.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
4.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
4.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
4.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
YAM minimal test file.5. YAM Syntax
5.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
5.2. Contents
Contents listings like that above are generated by '%contents'
5.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
5.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
5.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
5.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
5.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:5.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
5.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
5.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
5.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
5.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
5.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
5.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
5.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
5.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
5.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
YAM minimal test file.6. YAM Syntax
6.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
6.2. Contents
Contents listings like that above are generated by '%contents'
6.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
6.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
6.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
6.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
6.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:6.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
6.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
6.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
6.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
6.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
6.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
6.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
6.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
6.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
6.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
YAM minimal test file.7. YAM Syntax
7.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
7.2. Contents
Contents listings like that above are generated by '%contents'
7.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
7.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
7.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
7.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
7.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:7.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
7.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
7.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
7.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
7.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
7.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
7.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
7.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
7.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
7.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
YAM minimal test file.8. YAM Syntax
8.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
8.2. Contents
Contents listings like that above are generated by '%contents'
8.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
8.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
8.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
8.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
8.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:8.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
8.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
8.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
8.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
8.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
8.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
8.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
8.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
8.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
8.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
YAM minimal test file.9. YAM Syntax
9.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
9.2. Contents
Contents listings like that above are generated by '%contents'
9.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
9.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
9.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
9.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
9.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:9.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
9.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
9.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
9.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
9.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
9.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
9.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
9.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
9.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
9.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
YAM minimal test file.10. YAM Syntax
10.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
10.2. Contents
Contents listings like that above are generated by '%contents'
10.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
10.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
10.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
10.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
10.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:10.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
10.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
10.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
10.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
10.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
10.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
10.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
10.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
10.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
10.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
YAM minimal test file.11. YAM Syntax
11.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
11.2. Contents
Contents listings like that above are generated by '%contents'
11.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
11.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
11.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
11.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
11.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:11.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
11.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
11.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
11.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
11.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
11.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
11.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
11.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
11.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
11.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
YAM minimal test file.12. YAM Syntax
12.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
12.2. Contents
Contents listings like that above are generated by '%contents'
12.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
12.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
12.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
12.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
12.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:12.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
12.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
12.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
12.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
12.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
12.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
12.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
12.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
12.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
12.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
YAM minimal test file.13. YAM Syntax
13.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
13.2. Contents
Contents listings like that above are generated by '%contents'
13.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
13.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
13.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
13.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
13.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:13.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
13.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
13.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
13.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
13.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
13.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
13.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
13.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
13.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
13.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
YAM minimal test file.14. YAM Syntax
14.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
14.2. Contents
Contents listings like that above are generated by '%contents'
14.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
14.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
14.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
14.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
14.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:14.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
14.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
14.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
14.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
14.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
14.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
14.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
14.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
14.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
14.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
YAM minimal test file.15. YAM Syntax
15.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
15.2. Contents
Contents listings like that above are generated by '%contents'
15.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
15.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
15.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
15.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
15.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:15.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
15.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
15.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
15.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
15.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
15.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
15.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
15.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
15.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
15.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
YAM minimal test file.Contents
- 1. YAM Syntax
- 1.1. Changes from version 3
- 1.2. Contents
- 1.3. Bold, italic, underline and teletype
- 1.4. Horizontal lines
- 1.5. Lists
- 1.6. Verbatim output
- 1.7. Footnotes
- 1.8. Escapes
- 1.9. Headings
- 1.10. Links and anchors
- 1.11. Block quotations
- 1.12. Line breaks
- 1.13. Tables
- 1.14. Images
- 1.15. Citations
- 1.16. Inclusion
- 2. YAM Syntax
- 2.1. Changes from version 3
- 2.2. Contents
- 2.3. Bold, italic, underline and teletype
- 2.4. Horizontal lines
- 2.5. Lists
- 2.6. Verbatim output
- 2.7. Footnotes
- 2.8. Escapes
- 2.9. Headings
- 2.10. Links and anchors
- 2.11. Block quotations
- 2.12. Line breaks
- 2.13. Tables
- 2.14. Images
- 2.15. Citations
- 2.16. Inclusion
- 3. YAM Syntax
- 3.1. Changes from version 3
- 3.2. Contents
- 3.3. Bold, italic, underline and teletype
- 3.4. Horizontal lines
- 3.5. Lists
- 3.6. Verbatim output
- 3.7. Footnotes
- 3.8. Escapes
- 3.9. Headings
- 3.10. Links and anchors
- 3.11. Block quotations
- 3.12. Line breaks
- 3.13. Tables
- 3.14. Images
- 3.15. Citations
- 3.16. Inclusion
- 4. YAM Syntax
- 4.1. Changes from version 3
- 4.2. Contents
- 4.3. Bold, italic, underline and teletype
- 4.4. Horizontal lines
- 4.5. Lists
- 4.6. Verbatim output
- 4.7. Footnotes
- 4.8. Escapes
- 4.9. Headings
- 4.10. Links and anchors
- 4.11. Block quotations
- 4.12. Line breaks
- 4.13. Tables
- 4.14. Images
- 4.15. Citations
- 4.16. Inclusion
- 5. YAM Syntax
- 5.1. Changes from version 3
- 5.2. Contents
- 5.3. Bold, italic, underline and teletype
- 5.4. Horizontal lines
- 5.5. Lists
- 5.6. Verbatim output
- 5.7. Footnotes
- 5.8. Escapes
- 5.9. Headings
- 5.10. Links and anchors
- 5.11. Block quotations
- 5.12. Line breaks
- 5.13. Tables
- 5.14. Images
- 5.15. Citations
- 5.16. Inclusion
- 6. YAM Syntax
- 6.1. Changes from version 3
- 6.2. Contents
- 6.3. Bold, italic, underline and teletype
- 6.4. Horizontal lines
- 6.5. Lists
- 6.6. Verbatim output
- 6.7. Footnotes
- 6.8. Escapes
- 6.9. Headings
- 6.10. Links and anchors
- 6.11. Block quotations
- 6.12. Line breaks
- 6.13. Tables
- 6.14. Images
- 6.15. Citations
- 6.16. Inclusion
- 7. YAM Syntax
- 7.1. Changes from version 3
- 7.2. Contents
- 7.3. Bold, italic, underline and teletype
- 7.4. Horizontal lines
- 7.5. Lists
- 7.6. Verbatim output
- 7.7. Footnotes
- 7.8. Escapes
- 7.9. Headings
- 7.10. Links and anchors
- 7.11. Block quotations
- 7.12. Line breaks
- 7.13. Tables
- 7.14. Images
- 7.15. Citations
- 7.16. Inclusion
- 8. YAM Syntax
- 8.1. Changes from version 3
- 8.2. Contents
- 8.3. Bold, italic, underline and teletype
- 8.4. Horizontal lines
- 8.5. Lists
- 8.6. Verbatim output
- 8.7. Footnotes
- 8.8. Escapes
- 8.9. Headings
- 8.10. Links and anchors
- 8.11. Block quotations
- 8.12. Line breaks
- 8.13. Tables
- 8.14. Images
- 8.15. Citations
- 8.16. Inclusion
- 9. YAM Syntax
- 9.1. Changes from version 3
- 9.2. Contents
- 9.3. Bold, italic, underline and teletype
- 9.4. Horizontal lines
- 9.5. Lists
- 9.6. Verbatim output
- 9.7. Footnotes
- 9.8. Escapes
- 9.9. Headings
- 9.10. Links and anchors
- 9.11. Block quotations
- 9.12. Line breaks
- 9.13. Tables
- 9.14. Images
- 9.15. Citations
- 9.16. Inclusion
- 10. YAM Syntax
- 10.1. Changes from version 3
- 10.2. Contents
- 10.3. Bold, italic, underline and teletype
- 10.4. Horizontal lines
- 10.5. Lists
- 10.6. Verbatim output
- 10.7. Footnotes
- 10.8. Escapes
- 10.9. Headings
- 10.10. Links and anchors
- 10.11. Block quotations
- 10.12. Line breaks
- 10.13. Tables
- 10.14. Images
- 10.15. Citations
- 10.16. Inclusion
- 11. YAM Syntax
- 11.1. Changes from version 3
- 11.2. Contents
- 11.3. Bold, italic, underline and teletype
- 11.4. Horizontal lines
- 11.5. Lists
- 11.6. Verbatim output
- 11.7. Footnotes
- 11.8. Escapes
- 11.9. Headings
- 11.10. Links and anchors
- 11.11. Block quotations
- 11.12. Line breaks
- 11.13. Tables
- 11.14. Images
- 11.15. Citations
- 11.16. Inclusion
- 12. YAM Syntax
- 12.1. Changes from version 3
- 12.2. Contents
- 12.3. Bold, italic, underline and teletype
- 12.4. Horizontal lines
- 12.5. Lists
- 12.6. Verbatim output
- 12.7. Footnotes
- 12.8. Escapes
- 12.9. Headings
- 12.10. Links and anchors
- 12.11. Block quotations
- 12.12. Line breaks
- 12.13. Tables
- 12.14. Images
- 12.15. Citations
- 12.16. Inclusion
- 13. YAM Syntax
- 13.1. Changes from version 3
- 13.2. Contents
- 13.3. Bold, italic, underline and teletype
- 13.4. Horizontal lines
- 13.5. Lists
- 13.6. Verbatim output
- 13.7. Footnotes
- 13.8. Escapes
- 13.9. Headings
- 13.10. Links and anchors
- 13.11. Block quotations
- 13.12. Line breaks
- 13.13. Tables
- 13.14. Images
- 13.15. Citations
- 13.16. Inclusion
- 14. YAM Syntax
- 14.1. Changes from version 3
- 14.2. Contents
- 14.3. Bold, italic, underline and teletype
- 14.4. Horizontal lines
- 14.5. Lists
- 14.6. Verbatim output
- 14.7. Footnotes
- 14.8. Escapes
- 14.9. Headings
- 14.10. Links and anchors
- 14.11. Block quotations
- 14.12. Line breaks
- 14.13. Tables
- 14.14. Images
- 14.15. Citations
- 14.16. Inclusion
- 15. YAM Syntax
- 15.1. Changes from version 3
- 15.2. Contents
- 15.3. Bold, italic, underline and teletype
- 15.4. Horizontal lines
- 15.5. Lists
- 15.6. Verbatim output
- 15.7. Footnotes
- 15.8. Escapes
- 15.9. Headings
- 15.10. Links and anchors
- 15.11. Block quotations
- 15.12. Line breaks
- 15.13. Tables
- 15.14. Images
- 15.15. Citations
- 15.16. Inclusion
- 16. YAM Syntax
- 16.1. Changes from version 3
- 16.2. Contents
- 16.3. Bold, italic, underline and teletype
- 16.4. Horizontal lines
- 16.5. Lists
- 16.6. Verbatim output
- 16.7. Footnotes
- 16.8. Escapes
- 16.9. Headings
- 16.10. Links and anchors
- 16.11. Block quotations
- 16.12. Line breaks
- 16.13. Tables
- 16.14. Images
- 16.15. Citations
- 16.16. Inclusion
16. YAM Syntax
16.1. Changes from version 3
- horizontal lines are now three or more dashes
- comment syntax: %% for single lines, and /* */ for multiple lines (should replace notes?)
- addition of column separator bars at the start and end of table rows
- multiple lines allowed in titles
- added underlining
- no more %output function
- changed quotation syntax to %"
- changed of line break style to %\
- output is correct XHTML
- verbatim output is %< ... %>
- target language control characters (like < or &) now dealt with properly
- headings can be unnumbered, e.g. "%2*"
Slides: maybe:
- if the document contains %slides then treat it all as slides
- else if it contains %slide...%endslide then treat each of those as slides
16.2. Contents
Contents listings like that above are generated by '%contents'
16.3. Bold, italic, underline and teletype
Bold text is contained in stars: *this is bold* becomes this is bold.
Italic text is contained in underscores: _this is italic_ becomes this is italic.
Fixed-width text is contained in equals signs: =this is teletype= becomes this is teletype.
Underlined text is contained in doubles undercores: __this is underlined__ becomes this is underlined.
16.4. Horizontal lines
Horizontal lines are indicated by 3 or more - signs at the start of a line. For example:
---
and
---------------------------
both result in:
16.5. Lists
Unordered lists are indicated by '-' at the start of a line, and ordered lists by 'o'. Nesting is indicated by increased spacing preceding the item indicator. For example:
- This is an undordered list - Second item # This is a nested... # ...ordered list - Back to the third item of the enclosing list
results in:
- This is an undordered list
- Second item
- This is a nested...
- ...ordered list
- Back to the third item of the enclosing list
16.6. Verbatim output
Verbatim output starts with '%<' and ends with '%>'. For example:
%< This will *not* get translated. %>
When the target language is HTML, for example, the output will contain '<pre>' tags.
16.7. Footnotes
Footnotes are like this:
%footnote(This is a footnote.)
Becomes:16.
The contents will be put in a section at the end of the document (HTML) or at the bottom of the page (LaTeX), and linked by number from where they occured.
16.8. Escapes
To stop a special character from being interpreted, use a '\'. For example,
\---
will not generate a line.
16.9. Headings
Headings are lines starting with %1 (for first level), %2, %3 or %4. For example, the heading for this section is
%2 Headings
If a heading level is followed by "*" it is not numbered, e.g.:
%2* An unnumbered heading
Becomes:
An unnumbered heading
This heading will not appear in the contents table.
16.10. Links and anchors
Links can be specified in three ways:
- As plain text, e.g. 'http://gate.ac.uk/' will become http://gate.ac.uk/
- Using '%(target)', e.g. %(http://gate.ac.uk/) will become http://gate.ac.uk/
- Using '%(target, label)', e.g. %(http://gate.ac.uk/, GATE home) will become GATE home
Spaces or commas inside URLs must be escaped. A URL that appears in plain text must be followed by a space, tab or newline.
Anchors and labels are specified using '%#name'. For example,
%2 A Heading %#label
will result in a heading followed by the anchor label.
Spaces or commas inside anchors must be escaped. An anchor that appears in plain text must be followed by a space, tab or newline.
16.11. Block quotations
Block quotations are enclosed in %" marks. For example,
%"This is a quote%"
becomes:
This is a quote
16.12. Line breaks
Line breaks are indicated by %\ at the end of a line. For example:
This line is broken %\ in two.
becomes: % This line is broken % in two.
16.13. Tables
Tables use square brackets, bars and dashes. For example:
%[ | *header col 1* | *header col 2* | --- | row 1 col 1 | col 2 | --- | row 2 col 1 | col 2 | %]
results in:
| header col 1 | header col 2 |
| row 1 col 1 | col 2 |
| row 2 col 1 | col 2 |
16.14. Images
Images are like URLs:
- '%image(test-image.png)' will become
- '%image(test-image.png, a test image)' will become (the text becomes the "alt" attribute of the image)
You can also specify an ALT tag, width and height, position and border width:
'%image(test-image.png, ALT tag, 500, 500, left, 0)' becomes
16.15. Citations
Citations work like this: '%cite(Cun06a)' becomes Cun06a. Multiple cite keys should be separated by commas, e.g.: '%cite(Cun05a,Cun06a)' becomes Cun05a, Cun06a.
16.16. Inclusion
A page can include another page like this:
%include(yam-first.yam)
Becomes:
This, by way of contrast, is a paragraph.
This is another paragraph. It contains two lines.
Footnotes
- This is a footnote.
- This is a footnote.
- This is a footnote.
- This is a footnote.
- This is a footnote.
- This is a footnote.
- This is a footnote.
- This is a footnote.
- This is a footnote.
- This is a footnote.
- This is a footnote.
- This is a footnote.
- This is a footnote.
- This is a footnote.
- This is a footnote.
- This is a footnote.
