(Answer) (Category) Faq-O-Matic Faq-O-Matic : (Category) Users' Guide :
How to compose text
When editing a text box in Faq-O-Matic, there are three format options. "Natural text" and "Monospaced text" are the options available for this web site.
Monospaced text rules:

This is the simplest input format.  This just means that the output 
will look like the input, with almost no translation.  Text edited 
in this mode will appear in monospaced font on the web page.  This 
entry uses Monospaced text mode.

Be careful with line breaks if you use this type.  Web browsers will
not break the lines when you use this mode, so make sure to make your
lines a conservative width, like 60 columns.

Linking works the same as with Natural text mode, as described below.

Natural text, described next, is preferred over Monospaced text for
most situations, because it looks better when the FAQ is displayed
in different browsers and different formats.
Natural text rules:

Text formatting
  • Cause a line break in the text by leaving an empty line. This is like using the HTML <br> tag.
  • Cause a paragraph break in the text by leaving two empty lines. This is like using the HTML <p> tag.
  • Lines with leading spaces are formatted exactly as they appear in the input box, using a monospaced font. This is like using the HTML <pre> tag.
          Lines indented with spaces
       are formatted as monospaced text.
                         This is good
                    for concrete
  • Links to external sites:
    <http://www.dartmouth.edu/> in the input is translated to http://www.dartmouth.edu/ in the output. The target of the link always appears in the rendered text so that when the site is converted to ASCII text the links are still accessible.
  • Links to internal pages:
    Use <faqomatic []:#file#> to link to the internal page number #file#. You can find the file number of any page by looking at the bottom of the page you're interested in. There will be a line that looks like:
    This document is: http://www.jonh.net/cgi-bin/faqomatic/fom?file=428
    where #file# is after the file= parameter. Note that there is a space between "faqomatic" and "[]" in this example that is used to keep this example from being translated. Don't put a space there when you create a link.
  • Using < > without forming a link:
    If the thing inside the < > brackets doesn't look like a link (for example, it has a space in it), it will not be link-ified.

Some sites allow contributors to use Untranslated HTML (see (Xref) Composing text with Untranslated HTML); for this site, please email the moderator for the section where you need to use HTML if you have an entry that can only be created using Untranslated HTML.
Directory parts are formatted just like natural text parts.

You can reorganize and annotate the directory part to your heart's content, as long as all of the items that used to be in this category remain in it. Directory parts obey the special rules that they cannot be converted into any other type, and you cannot change the set of faqomatic: links in them. That's because the directory parts actually maintain the structure of categories and answers in the FAQ. To move an answer (or subcategory), use the [Move Answer] or [Trash Answer] commands near the top of the answer's page.

[Append to This Answer]
Previous: (Answer) Contributing to an Existing Item
Next: (Answer) Composing text with Untranslated HTML
This document is: http://www.jonh.net/cgi-bin/faqomatic/fom?file=1783
[Search] [Appearance]
This is a Faq-O-Matic 2.718d.
Hosted by SourceForge Logo and jonh.net.