Class | Text::Format |
In: |
lib/text/format.rb
|
Parent: | Object |
Text::Format provides the ability to nicely format fixed-width text with knowledge of the writeable space (number of columns), margins, and indentation settings.
Copyright: | Copyright (c) 2002 - 2005 by Austin Ziegler |
Version: | 1.0.0 |
Based On: | Perl Text::Format, Copyright (c) 1998 Gábor Egressy |
Licence: | Ruby‘s, Perl Artistic, or GPL version 2 (or later) |
VERSION | = | '1.0.0' | ||
SPACES_RE | = | %r{\s+}mo.freeze | ||
NEWLINE_RE | = | %r{\n}o.freeze | ||
TAB | = | "\t".freeze | ||
NEWLINE | = | "\n".freeze | ||
ABBREV | = | %w(Mr Mrs Ms Jr Sr Dr) | Global common English abbreviations. More can be added with abbreviations. | |
LEFT_ALIGN | = | :left |
Formats text flush to the left margin with a visual and physical ragged
right margin.
>A paragraph that is< >left aligned.< |
|
RIGHT_ALIGN | = | :right |
Formats text flush to the right margin with a visual ragged left margin.
The actual left margin is padded with spaces from the beginning of the line
to the start of the text such that the right margin will be flush.
>A paragraph that is< > right aligned.< |
|
RIGHT_FILL | = | :fill |
Formats text flush to the left margin with a visual ragged right margin.
The line is padded with spaces from the end of the text to the right
margin.
>A paragraph that is< >right filled. < |
|
JUSTIFY | = | :justify |
Formats the text flush to both the left and right margins. The last line
will not be justified if it consists of a single word (it will be treated
as RIGHT_FILL in this case). Spacing between words is increased to
ensure that the textg is flush with both margins.
|A paragraph that| |is justified.| |A paragraph that is| |justified. | |
|
SPLIT_FIXED | = | 1 |
When hard_margins is enabled, a word that extends over the right margin
will be split at the number of characters needed. This is similar to how
characters wrap on a terminal. This is the default split mechanism when
hard_margins is enabled.
repre senta ion |
|
SPLIT_CONTINUATION | = | 2 |
When hard_margins is enabled, a word that extends over the right margin
will be split at one less than the number of characters needed with a
C-style continuation character (\). If the word cannot be split using the
rules of SPLIT_CONTINUATION, and the word will not fit wholly into the next
line, then SPLIT_FIXED will be used.
repr # esen # tati # on |
|
SPLIT_HYPHENATION | = | 4 |
When hard_margins is enabled, a word that extends over the right margin
will be split according to the hyphenator specified by the hyphenator
object; if there is no hyphenation library supplied, then the hyphenator of
Text::Format itself is used, which is the same as
SPLIT_CONTINUATION. See hyphenator for more information about hyphenation
libraries. The example below is valid with either TeX::Hyphen or
Text::Hyphen. If the word cannot be split using the hyphenator‘s
rules, and the word will not fit wholly into the next line, then
SPLIT_FIXED will be used.
rep- re- sen- ta- tion |
|
SPLIT_CONTINUATION_FIXED | = | SPLIT_CONTINUATION | SPLIT_FIXED | When hard_margins is enabled, a word that extends over the right margin will be split at one less than the number of characters needed with a C-style continuation character (\). If the word cannot be split using the rules of SPLIT_CONTINUATION, then SPLIT_FIXED will be used. | |
SPLIT_HYPHENATION_FIXED | = | SPLIT_HYPHENATION | SPLIT_FIXED | When hard_margins is enabled, a word that extends over the right margin will be split according to the hyphenator specified by the hyphenator object; if there is no hyphenation library supplied, then the hyphenator of Text::Format itself is used, which is the same as SPLIT_CONTINUATION. See hyphenator for more information about hyphenation libraries. The example below is valid with either TeX::Hyphen or Text::Hyphen. If the word cannot be split using the hyphenator‘s rules, then SPLIT_FIXED will be used. | |
SPLIT_HYPHENATION_CONTINUATION | = | SPLIT_HYPHENATION | SPLIT_CONTINUATION | Attempts to split words according to the rules of the supplied hyphenator (e.g., SPLIT_HYPHENATION); if the word cannot be split using these rules, then the rules of SPLIT_CONTINUATION will be followed. In all cases, if the word cannot be split using either SPLIT_HYPHENATION or SPLIT_CONTINUATION, and the word will not fit wholly into the next line, then SPLIT_FIXED will be used. | |
SPLIT_ALL | = | SPLIT_HYPHENATION | SPLIT_CONTINUATION | SPLIT_FIXED | Attempts to split words according to the rules of the supplied hyphenator (e.g., SPLIT_HYPHENATION); if the word cannot be split using these rules, then the rules of SPLIT_CONTINUATION will be followed. In all cases, if the word cannot be split using either SPLIT_HYPHENATION or SPLIT_CONTINUATION, then SPLIT_FIXED will be used. | |
TERMINAL_PUNCTUATION | = | %q(.?!) | Indicates punctuation characters that terminates a sentence, as some English typesetting rules indicate that sentences should be followed by two spaces. This is an archaic rule, but is supported with extra_space. This is the default set of terminal punctuation characters. Additional terminal punctuation may be added to the formatting object through terminal_punctuation. | |
TERMINAL_QUOTES | = | %q('") | Indicates quote characters that may follow terminal punctuation under the current formatting rules. This satisfies the English formatting rule that indicates that sentences terminated inside of quotes should have the punctuation inside of the quoted text, not outside of the terminal quote. Additional terminal quotes may be added to the formatting object through terminal_quotes. See TERMINAL_PUNCTUATION for more information. | |
RE_BREAK_SIZE | = | lambda { |size| %r[((?:\S+\s+){#{size}})(.+)] } | Returns a regular expression for a set of characters (at least one non-whitespace followed by at least one space) of the specified size followed by one or more of any character. |
abbreviations | [RW] |
Defines the current abbreviations as an array. This is only used if
extra_space is turned on.
If one is abbreviating "President" as "Pres." (abbreviations = ["Pres"]), then the results of formatting will be as illustrated in the table below: abbreviations extra_space | #include?("Pres") | not #include?("Pres") ------------+-------------------+---------------------- true | Pres. Lincoln | Pres. Lincoln false | Pres. Lincoln | Pres. Lincoln ------------+-------------------+---------------------- extra_space | #include?("Mrs") | not #include?("Mrs") true | Mrs. Lincoln | Mrs. Lincoln false | Mrs. Lincoln | Mrs. Lincoln Note that abbreviations should not have the terminal period as part of their definitions. This automatic abbreviation handling will cause some issues with uncommon sentence structures. The two sentences below will not be formatted correctly: You're in trouble now, Mr. Just wait until your father gets home. Under no circumstances (because Mr is a predefined abbreviation) will this ever be separated by two spaces.
|
||||
body_indent | [RW] |
The number of spaces to indent all lines after the first line of a
paragraph. The value provided is silently converted to a positive integer
value.
columns <--------------------------------------------------------------> <-----------><------><---------------------------><------------> left margin INDENT text is formatted into here right margin
|
||||
columns | [RW] |
The total width of the format area. The
margins, indentation, and text are formatted into this space. Any value
provided is silently converted to a positive integer.
COLUMNS <--------------------------------------------------------------> <-----------><------><---------------------------><------------> left margin indent text is formatted into here right margin
|
||||
extra_space | [RW] |
Indicates whether sentence terminators should be followed by a single space
(false), or two spaces (true). See abbreviations for more
information.
|
||||
first_indent | [RW] |
The number of spaces to indent the first line of a paragraph. The value
provided is silently converted to a positive integer value.
columns <--------------------------------------------------------------> <-----------><------><---------------------------><------------> left margin INDENT text is formatted into here right margin
|
||||
format_style | [RW] |
Specifies the format style. Allowable
values are: *LEFT_ALIGN *RIGHT_ALIGN *RIGHT_FILL
*JUSTIFY
|
||||
hard_margins | [RW] |
Normally, words larger than the format
area will be placed on a line by themselves. Setting this value to
true will force words larger than the format area to be split into one or more
"words" each at most the size of the format area. The first line and the original
word will be placed into split_words. Note that this will cause the output
to look similar to a format_style of JUSTIFY. (Lines will be filled
as much as possible.)
|
||||
hyphenator | [RW] |
The object responsible for hyphenating. It must respond to hyphenate_to(word, size) or hyphenate_to(word, size, formatter) and
return an array of the word split into two parts (e.g., [part1,
part2]; if there is a hyphenation mark to be applied, responsibility
belongs to the hyphenator object. The size is the MAXIMUM size permitted,
including any hyphenation marks.
If the hyphenate_to method has an arity of 3, the current formatter (self) will be provided to the method. This allows the hyphenator to make decisions about the hyphenation based on the formatting rules. hyphenate_to should return [nil, word] if the word cannot be hyphenated.
|
||||
left_margin | [RW] |
The number of spaces used for the left margin. The value provided is
silently converted to a positive integer value.
columns <--------------------------------------------------------------> <-----------><------><---------------------------><------------> LEFT MARGIN indent text is formatted into here right margin
|
||||
nobreak | [RW] |
Indicates whether or not the non-breaking space feature should be used.
|
||||
nobreak_regex | [RW] |
A hash which holds the regular expressions on which spaces should not be
broken. The hash is set up such that the key is the first word and the
value is the second word.
For example, if nobreak_regex contains the following hash: { %r{Mrs?\.?} => %r{\S+}, %r{\S+} => %r{(?:[SJ])r\.?} } Then "Mr. Jones", "Mrs Jones", and "Jones Jr." would not be broken. If this simple matching algorithm indicates that there should not be a break at the current end of line, then a backtrack is done until there are two words on which line breaking is permitted. If two such words are not found, then the end of the line will be broken regardless. If there is a single word on the current line, then no backtrack is done and the word is stuck on the end.
|
||||
right_margin | [RW] |
The number of spaces used for the right margin. The value provided is
silently converted to a positive integer value.
columns <--------------------------------------------------------------> <-----------><------><---------------------------><------------> left margin indent text is formatted into here RIGHT MARGIN
|
||||
split_rules | [RW] |
Specifies the split mode; used only when hard_margins is set to
true. Allowable values are:
|
||||
split_words | [R] |
An array of words split during formatting if hard_margins is set to
true.
#split_words << Text::Format::SplitWord.new(word, first, rest) |
||||
tabstop | [RW] |
Indicates the number of spaces that a single tab represents. Any value
provided is silently converted to a positive integer.
|
||||
tag_paragraph | [RW] |
Indicates whether the formatting of paragraphs should be done with tagged paragraphs. Useful only with tag_text.
|
||||
tag_text | [RW] |
The text to be placed before each paragraph when tag_paragraph is
true. When format is called,
only the first element (tag_text[0]) is used. When paragraphs is called, then each successive
element (tag_text[n]) will be used once, with corresponding paragraphs. If the tag elements are
exhausted before the text is exhausted, then the remaining paragraphs will not be tagged. Regardless of
indentation settings, a blank line will be inserted between all paragraphs when tag_paragraph is
true.
The Text::Format package provides three number generators, Text::Format::Alpha, Text::Format::Number, and Text::Format::Roman to assist with the numbering of paragraphs.
|
||||
terminal_punctuation | [RW] |
Specifies additional punctuation characters that terminate a sentence, as
some English typesetting rules indicate that sentences should be followed
by two spaces. This is an archaic rule, but is supported with extra_space.
This is added to the default set of terminal punctuation defined in
TERMINAL_PUNCTUATION.
|
||||
terminal_quotes | [RW] |
Specifies additional quote characters that may follow terminal punctuation
under the current formatting rules. This satisfies the English formatting
rule that indicates that sentences terminated inside of quotes should have
the punctuation inside of the quoted text, not outside of the terminal
quote. This is added to the default set of terminal quotes defined in
TERMINAL_QUOTES.
|
||||
text | [RW] |
The default text to be manipulated. Note that value is optional, but if the
formatting functions are called without values, this text is what will be
formatted.
|
Create a Text::Format object. Accepts an optional hash of construction options (this will be changed to named paramters in Ruby 2.0). After the initial object is constructed (with either the provided or default values), the object will be yielded (as self) to an optional block for further construction and operation.
Compares the formatting rules, excepting hyphenator, of two Text::Format objects. Generated results (e.g., split_words) are not compared.
The formatting object itself can be used as a hyphenator, where the default implementation of hyphenate_to implements the conditions necessary to properly produce SPLIT_CONTINUATION.
Indicates that the format style is full justification.
Default: | false |
Used in: | format, paragraphs |
Indicates that the format style is left alignment.
Default: | true |
Used in: | format, paragraphs |
Considers each element of text (provided or internal) as a paragraph. If first_indent is the same as body_indent, then paragraphs will be separated by a single empty line in the result; otherwise, the paragraphs will follow immediately after each other. Uses format to do the heavy lifting.
If to_wrap responds to split, then it will be split into an array of elements by calling split with the value of split_on. The default value of split_on is $/, or the default record separator, repeated twice (e.g., /\n\n/).
Indicates that the format style is right alignment.
Default: | false |
Used in: | format, paragraphs |
Indicates that the format style is right fill.
Default: | false |
Used in: | format, paragraphs |