textutil::adjust - Procedures to adjust, indent, and undent paragraphs
The package textutil::adjust provides commands that manipulate strings or texts (a.k.a. long strings or string with embedded newlines or paragraphs), adjusting, or indenting them.
The complete set of procedures is described below.
Do a justification on the string according to the options. The string is taken as one big paragraph, ignoring any newlines. Then the line is formatted according to the options used, and the command returns a new string with enough lines to contain all the printable chars in the input string. A line is a set of characters between the beginning of the string and a newline, or between 2 newlines, or between a newline and the end of the string. If the input string is small enough, the returned string won't contain any newlines.
Together with ::textutil::adjust::indent it is possible to create properly wrapped paragraphs with arbitrary indentations.
By default, any occurrence of space or tabulation characters are replaced by a single space so that each word in a line is separated from the next one by exactly one space character, and this forms a real line. Each real line is placed in a logical line, which has exactly a given length (see the option -length below). The real line may be shorter. Again by default, trailing spaces are ignored before returning the string (see the option -full below).
The following options may be used after the string parameter, and change the way the command places a real line in a logical line.
Loads the internal storage for hyphenation patterns with the contents of the file filename. This has to be done prior to calling command ::textutil::adjust::adjust with "-hyphenate true", or the hyphenation process will not work correctly.
The package comes with a number of predefined pattern files, and the command ::textutil::adjust::listPredefined can be used to find out their names.
This command returns a list containing the names of the hyphenation files coming with this package.
Use this command to query the package for the full path name of the hyphenation file filename coming with the package. Only the filenames found in the list returned by ::textutil::adjust::listPredefined are legal arguments for this command.
Each line in the string is indented by adding the string prefix at its beginning. The modified string is returned as the result of the command.
If skip is specified the first skip lines are left untouched. The default for skip is 0, causing the modification of all lines. Negative values for skip are treated like 0. In other words, skip > 0 creates a hanging indentation.
Together with ::textutil::adjust::adjust it is possible to create properly wrapped paragraphs with arbitrary indentations.
The command computes the common prefix for all lines in string consisting solely out of whitespace, removes this from each line and returns the modified string.
Lines containing only whitespace are always reduced to completely empty lines. They and empty lines are also ignored when computing the prefix to remove.
Together with ::textutil::adjust::adjust it is possible to create properly wrapped paragraphs with arbitrary indentations.
This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category textutil of the Tcllib Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.
regexp(n), split(n), string(n)
TeX, adjusting, formatting, hyphenation, indenting, justification, paragraph, string, undenting
Text processing