Home The syntax of UDO Special characters Images

Syllabification

UDO supports a semi-automatic syllabification for ASCII, ST-Guide, Pure C Help and Manualpage. "Semi-automatic" means that you have to tell UDO at which position a word can be divided into two pieces.

You have two possibilities to set the syllabification patterns:

  1. Local definition ("!-")
  2. Global definition using the !hyphen command

When converting to LaTeX the marks will be replaced by "\-". Then LaTeX knows that a word can be split at these positions.

When converting to RTF, Windows Help and HTML the marks are deleted.

If you want to display !- you have to use !/-.


Local definition of syllabification patterns

You can set the syllabification marks in the source file using "!-". At these marks UDO is allowed to split up a word. A short example:

semi-automatic syl!-labi!-fi!-cation

When converting to LaTeX UDO replaces all "!-" by "\-". So it would look like "syl\-labi\-fi\-cation".

Converting to ASCII, ST-Guide, Pure C Help and Manualpage the word is split up into different parts if it doesn't have enough place at the end of a line. So it can look like "syl- labification", "syllabi- fication" or "syllabifi- cation"

When converting to other formats the marks are simply deleted.

Global definition of syllabification patterns

You can set these marks at the beginning of a source file with the !hyphen command for often used words. "Global" means that you only have to define the marks once.

If a word hasn't enough place at the end of a line when converting to ASCII, ST-Guide, Pure C Help or Manualpage UDO looks for a global definition in its internal list.

In the following example I expect that the word "documentation" is used many times in your source file:

!hyphen docu!-men!-ta!-tion

Short lines

When converting to ASCII, Pure C Help, ST-Guide or Manualpage UDO can generate a relative regular right margin due to its semi-automatic syllabification.

The right margin becomes irregular when long words haven't enough place at the end of a line. UDO will print a warning containing the specific word and you should try to insert some syllabification marks.

Please note:

The command !sloppy switches of these warnings, !fussy switches them back on. While developing a documentation you should use !sloppy. At the end of developing a text you should comment this switch and you should look after warnings according short lines.


Home The syntax of UDO Special characters Images