< Images | External links > |
A link always needs a target and a source. Both can be put into an STML text easily.
A simple link target just points to one of the documents in the help set. Therefore, the document has to be referenced. This is simply done by attaching a label to the document with the “:label” command. You should only put one label in each document. Best practice is to put it directly after the “:title” command:
:title Great inventors
:label inventors
Mankind would not have come that far without these people:
- James Watt, the inventor of the steam engine
- Thomas Alva Edison, who manufactured the first light bulb
- Konrad Zuse, maker of the first programmable computer that actually worked
Referencing to such a document from any other document is done by the reference inline command. The link target is defined by the label of the command, surrounded by “<< >>” and accompaigned by the text to write at the source location:
To get knowledge about important persons, look at the <<inventors|inventors' page>>.
To get knowledge about important persons, look at the inventors' page.
It is possible to put text markup for bold, italic or typewriter text, line breaks and non-breakable spaces into the link's text.
It is also possible to reference not at the begin of another page but somewhere within it. Therefore, an anchor must be defined with the “:anchor” command.
:title Great inventors
:label inventors
Mankind would not have come that far without these people:
- James Watt, the inventor of the steam engine
- Thomas Alva Edison, who manufactured the first light bulb
:anchor zuse
- Konrad Zuse, maker of the first programmable computer that actually worked
The “real” anchor in the document is always put directly after the actual anchor definition in the STML source. Normally, this position is at the beginning of the next paragraph or image. As you see, you can put anchors also at certain list elements.
Referencing an anchor is done by combining the label and the anchor of the target, glued by a “#”:
An example of an important computer engineer is the German <<inventors#zuse|Konrad //Zuse//>>.
An example of an important computer engineer is the German Konrad Zuse.
< Images | External links > |