2
0
Fork 0
textout/docs/language/document.rst

2.3 KiB

Document structure

These tags can be used to represent the document structure.

Titles and subtitles

In order to represent titles and subtitles integrated with the website's design, the [title] and [subtitles] tags can be used:

[title]Just do it![/]
[subtitle]Don't let your dreams be dreams![/]

Note

These tags cannot embed other tags.

Labels and targets

Internal references can be defined using labels and targets:

  • Labels place an anchor on a part of the message. They are defined using the [label=<your label>] tag.
  • Targets make a link to a label in another part of the message. They are defined using the [target=<your label>] tag.

Note

The [label] tag does not need to be terminated; in fact, the original version of the tag did not support termination.

An example usage of these tags is the following:

[label=sometag][subtitle]Some chapter[/subtitle]

...

[target=sometag]Go back to the beginning of the chapter[/]

Hyperlinks

Hyperlinks, i.e. reference to other documents available on the World Wide Web, can be inserted using the [url] tag. The URL can be provided:

  • As the tag value, e.g. [url=https://example.org/]My name[/url]. This is mostly useful in order to place a label.
  • As the tag contents, e.g. [url]https://example.org/[/url].

The URL itself can be either absolute, relative, or related to an anchor.

Example uses are the following:

[url]https://planet-casio.com[/]
[url=https://planet-casio.com]Planète Casio[/]
[url=/relative/url.html][/]

For links to profiles, the [profil] and [profile] tags can be used. They take no attribute but take a content which is the user whose the profile is to be linked's name. For example:

[profil]Cakeisalie5[/]

For links to topics and tutorials, the [topic] and [tutorial] tags can be used. They take no attribute but take a content which is the identifier of the topic or tutorial to which to link to. For example:

[topic]234[/]
[tutorial]32[/]

For links to programs, the [program] and [prog] tags can be used. They take no attribute but take a content which is the identifier of the program to which to link to. For example:

[program]3598[/program]