setext-info.txt

nedit 是一款linux下的开发源码的功能强大的编辑器

  discussed in length in the previous sections. All typotag
  elements, but the subhead-tt, are optional, that is, not
  necessary for a setext to be declared as such. The simple
  character marking typotags, bold-tt, italic-tt, and underline-tt
  have been used throughout the document and are used to mark text
  with their obvious meanings.

3>Section-tt (document divisions)

  The section-tt allows subdividing of the setext into further
  subsections for greater nesting capability. Typical usage starts
  the numbering level at 3 because the title-tt and subhead-tt
  basically represent sections 1 and 2, respectively.

3>Bullet-tt (list marker)

  The bullet-tt typotag is use to create a list of items. Note that
  it can only be used to create single line entries, like the
  following:
  
    Column 1 of text line
    |
    V
    * This is the first bullet.
    * This is the second bullet.
  
  Remember that you have to insert empty lines immediately before
  and after the bullet list.

3>Untouch-tt, Notouch-tt, Passthru-tt, Escape-tt (quoting text)

  Each one of these leave-my-text-alone typotags offer varying
  degrees of operation. The untouch-tt surrounds the text that
  is not to be interpreted. The accent grave (`) character is
  used to start and finish the untouchable text. (An extension
  to this has been allowed in the setext utility. An untouch-tt
  may be terminated by an apostrophe (').) The following are
  all valid untouch-tt typotags.
  
    `this is the _original_ version of the untouch-tt`
    `this is the _extended_ form of the untouch-tt'
    `This couldn't _be_ a problem could it?'

  Note that the third example has used the contraction "couldn't"
  which did not terminate the untouch-tt because the apostrophe was
  not followed by whitespace or punctuation.
  
  The notouch-tt typotag is used to take care of entire lines of
  text. The difference between this and the untouch-tt is that there
  is no visual residual typotag mark left in the output. It is
  replaced by a space. For example,
  
    Column 1 of text line
    |
    V
    ! This line of text will look like this sans the ! in column 1.

  becomes,
  
      This line of text will look like this sans the ! in column 1.

  The difference between the passthru-tt and the notouch-tt is
  the subtle difference of not replacing the markers with space, but
  totally removing them. (The original usage was to try to emit
  special 'C' compiler directives directly into the help code
  product). Thus,
  
    Column 1 of text line
    |
    V
    !!#ifdef VMS

  would turn into
  
    #ifdef VMS
  
  The escape-tt (@) is used to escape the special markers of 
  the other typotags and itself. Here is an example of escaping
  itself.
  
    develop@@nedit.org

  This will become "[e-mail]" in resulting documents.
  

3>Suppress-tt, Twodot-tt (author annotations or comments)

  The suppress-tt typotag allows an author to place annotations in a
  setext document which will not appear in a generated product. Most
  of the extensions to the original setext definition were placed
  inside this form of typotag.
  
    Column 1 of text line
    |
    V
    .. This is a document comment that would normally disappear
    .. from generated text, html, or the like. These lines are
    .. what constitute a suppress-tt. The following line is the
    .. twodot-tt.
    ..
    
3>Hot-tt, Href-tt, Target-tt (hyperlinking text)

  These three typotags are used in conjunction to create
  hypertext reference mechanism used int HTML and NEdit
  help code generation. The hot-tt is an original typotag which
  needed the additional two tags to be able create actual hyperlinks
  to other sections of the document, or to external references that
  could be exploited. These tags are ignored (stripped) when
  generating simple text documents.
  
  The hot-tt typotag is used to mark the text which would be used as
  the doorway to accessing other parts of the document. It either
  references a title or subhead string directly, or an href-tt. An
  href-tt (hypertext reference typotag) is used as an intermediary
  for the hyperlink destination. Its value either specifies an
  external document reference, or an internal document reference.
  The target-tt is used to mark the internal document references
  mentioned in a href-tt.
  
  Now for some examples. All the marked text will be inside
  parenthesis so it will stand out as to what explicitly is being
  marked. 
  
  This hot-tt directly references the (Typotags_Available_)
  subheading above. Whereas, the following hot-tt (references_) 
  the href-tt marked by this target-tt (_typotag).

  Here is what the href-tt would look like:
  
    Column 1 of text line
    |
    V
!   .. _references #typotsg

.. The following line is the actual hypertext reference in this
.. document. This annotation is an example of supress-tt usage. 
.. _references #typotag

3>Maybe[not]-tt, Endmaybe-tt (conditional text regions)

  Multiple line maybe-tt or maybenot-tt (conditional text regions)
  are introduced as follows:

    Column 1 of text line
    |
    V
    .. ? name~   (this is the maybe-tt)
    .. ! name~   (this is the maybenot-tt)
    
  Both are terminated with an endmaybe-tt on a separate line.

    Column 1 of text line
    |
    V
    .. ~ name

  The name* of the conditional region is left up to the text
  author.  Single line maybe[not]-tt typotags do not use the '~'
  character at the end of the name and are terminated at the end
  of the line. 

    Column 1 of text line
    |
    V
    .. ? oneLine (This is a one line maybe-tt)
    .. ! oneLine (This is a one line maybenot-tt)
  
  * There are some predefined conditional region names that are
  already known to the setext parser: html, text, and (NEdit) help.
  The special conditional text region named "html" allows a mixture
  of setext and HTML tags.

  Nesting of conditional text regions is allowed. For instance, if
  there are three conditional regions, A, B, and C, C can be nested
  inside B, which can be nested inside A. For example,
  A-B-C...C-B-A. 

      Column 1 of text line
    |
    V
    .. ? A~    Example of legally nested conditional text regions
    .. ? B~
    .. ? C~
    .. ~ C
    .. ~ B
    .. ~ A
  
  Note that a surrounding region cannot end before one of its inner
  regions is terminated (eg. of illegal nesting A-B-C...C-A-B,
  where A terminated prior to B).

3>Field-tt (variable definition and substitution)

  Field-tt typotags are used to define variables and reference
  their values. Field definitions can only occur within a
  suppress-tt.

  For example, to define the variable 'author' and fill it
  with the value "Steven Haehn":
 
      Column 1 of text line
    |
    V
    .. |>author=Steven Haehn<|

  To use the value of the defined variable, place the field-tt,
  |>author<|, in any printable text region. If there is no known
  value for the  field, it will remain unchanged and appear as
  written in the setext.

  The following are predefined for use in a field-tt
  for any setext document translated by the setext utility.

    Date = <MonthName day, year>         (eg. December 6, 2001)
    date = <MonthAbbreviation day, year> (eg. Dec 6, 2001)
    year = <year>                        (eg. 2001)

3>Line-tt (horizontal rule demarcation)

  This typotag is used to place horizontal markers into generated
  text documents. Like the following.

   Column 4 of text line
   |
   V
   -------------------------------------------------------------  

3>Twobuck-tt (setext termination marker)

  This typotag is used to mark the end of document parsing.
  
 $$

$Id: setext-info.txt,v 1.3 2002/09/26 12:37:38 ajhood Exp $