Class: TextFormatter (in Comanche)

• Inheritance
• Class protocol
  • formatting
  • initialize-release
  • instance creation
• Instance protocol
  • accessing
  • initializing
  • private
  • processing

Inheritance:

   Object
   |
   +--Comanche::TextFormatter
      |
      +--Comanche::BookTemplateFormatter
      |
      +--Comanche::PageFormatter
      |
      +--Comanche::ShelfTemplateFormatter

Package:

stx:goodies/webServer/comanche/swiki

Category:

Comanche-Swiki-Formatting

Version:

rev: 1.11 date: 2018/05/15 12:18:56

user: sr

file: TextFormatter.st directory: goodies/webServer/comanche/swiki

module: stx stc-classLibrary: swiki

Class protocol:

 crToCrlf: aCrDelimitedString

 crlfToCr: aCrlfDelimitedString

 decodeFromHttp: aHttpString

 decodeFromXmlCr

 decodeFromXmlCr: xml

 decodeFromXmlCrlf

 decodeFromXmlCrlf: xml

 encodeToHttp: aString

 encodeToStrictXmlCr

 encodeToStrictXmlCr: aString

 encodeToStrictXmlCrlf

 encodeToStrictXmlCrlf: aString

 encodeToXmlCr

 encodeToXmlCr: aString

 encodeToXmlCrlf

 encodeToXmlCrlf: aString

 initialize

Carriage Return Conversions

Usage example(s):

self initialize

 new

(comment from inherited method)
return an instance of myself without indexed variables

Instance protocol:

 addAction: block from: beginning to: end

When the Action is performed, the text is scanned for things that start with beginning
and stop with end. Whatever is between these two is then put into the block and what
gets returned is fed to the formatted document.

 addMappingFrom: original to: replacement

A Mapping is when the text is scanned and all instances of original are mapped to
their replacements.

 remove: key

Removes a formatter (action, mapping) from the TextFormatter.

 initialize

(comment from inherited method)
just to ignore initialize to objects which do not need it

 action: action value: value text: text

 addFormatter: formatter at: position

Adds a formatter to the position in the formattingArray.

 format: text actionValue: value onTo: stream

Apply all the formatting on text and put it onto stream.

 format: text

Apply all the formatting to the text and return it as a stream

 format: text onTo: stream