Правила форматирования текста

В система TWiki используется простые правила оформления текста. Вам не нужно знать HTML, хотя при необходимости вы можете его использовать.

Ссылки на другие странички распознаются автоматически, если они являются WikiWords?, то есть словами, написаными слитно без пробелов с заглавной Буквой где то в середине.

Шпаргалка

1й абзац

2й абзац

---++ Sushi

---+++ Maguro

*Жирный*

_Италик_

__Жирный италик__

=Fixed font=

==Bold fixed==

_This works_,
_this not _

<verbatim>
class CatAnimal {
  void purr() {
    <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

-------

   * bullet item

   * level 1
      * level 2

   1 Sushi
   1 Dim Sum

   Sushi: Japan
   Dim Sum: S.F.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |
|^| six | six |

WebNotify

Know.ReadmeFirst

[[wiki syntax]]

[[Main.TWiki users]]

[[WikiSyntax][syntax]]

[[http://gnu.org][GNU]]

[[http://xml.org XML]]

[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

<nop>SunOS

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

[[mailto:a@z.com Mail]]

[[mailto:?subject=Hi Hi]]

Using HTML

You can use just about any HTML tag without a problem - however, there are a few usability and technical considerations to keep in mind.

HTML and TWiki Usability

• On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
• NOTE: TWiki is designed to work with a wide range of browsers and computer platforms, holding to HTML 3.2 compatibility in the standard installation - adding raw HTML, particularly browser-specific tags (or any other mark-up that doesn't degrade well) will reduce compatibility.

TWiki HTML Rendering

• TWiki converts shorthand notation to XHTML 1.0 for display. To copy a fully marked-up page, simply view source in your browser and save the contents.
  • If you need to save HTML frequently, you may want to check out TWiki:Plugins/GenHTMLAddon - it will "generate a directory containing rendered versions of a set of TWiki pages together with any attached files."
• NOTE: The opening and closing angle brackets - <...> - of an HTML tag must be on the same line, or the tag will be broken.
  • This feature allows you to enter an unclosed angle bracket - as a greater than or less than symbol - and have it automatically rendered as if you had entered its HTML character, <, ex: a < b
  • If you're pasting in preformatted HTML text and notice problems, check the file in a text processor with no text wrap. Also, save without hard line breaks on text wrap, in your HTML editing program.

Hyperlinks

Being able to create links without any formatting required is a core TWiki feature, made possible with WikiWords?. New TWiki linking rules are a simple extension of the syntax that provide a new set of flexible options.

Internal Links

• GoodStyle? is a WikiWord? that links to the GoodStyle topic located in the current ACM web.

• NotExistingYet? is a topic waiting to be written. Create the topic by clicking on the ?. (Try clicking, but then, Cancel - creating the topic would wreck this example!)

External Links

• http://..., https://..., ftp://..., gopher://..., news://..., file://..., telnet://... and mailto:...@... are linked automatically.

• Email addresses like name@domain.com are linked automatically.

• [[Square bracket rules]] let you easily create non-WikiWord links.
  • You can also write [[http://yahoo.com Yahoo home page]] as an easier way of doing external links with descriptive text for the link, such as Yahoo home page.

TWiki Variables

Variables are names that are enclosed in percent signs % that are expanded on the fly.

• %TOC% : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.

• %WEB% : The current web, is Help.

• %TOPIC% : The current topic name, is TextFormattingRules.

• %ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

• %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current ACM web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

• %SEARCH{"sushi"}% : Inline search showing the search result embedded in a topic. FormattedSearch? gives you control over formatting, used to create web-based applications.

• TWikiPreferences? defines site-wide variables. Among others:
  • Line break: Write %BR% to start a new line.
  • Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
  • Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics?.

• There are many more variables, see TWikiVariables?.

• To "escape" a percent sign that would otherwise be interpreted as a variable, add <nop> after the first percent sign. Write: %<nop>SOMEVARIABLE% to get: %SOMEVARIABLE%.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of ACM into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

• DefaultPlugin: This plugin can be used to specify some simple custom rendering rules. It also renders deprecated *_text_* as bold italic text.
• SpreadSheetPlugin: Add spreadsheet calculation like "$SUM( $ABOVE() )" to tables located in ACM topics.
• BeautifierPlugin: Highlights and formats code fragments.
• EditTablePlugin: Edit TWiki tables using edit fields and drop down boxes
• EmptyPlugin: This plugin does nothing, but can be used as a template for your own plugins.
• GnuSkinPlugin: Supplements the bare bones GnuSkin? theme for TWiki
• HeadlinesPlugin: Build news portals that show headline news based on RSS news feeds from news sites.
• InterwikiPlugin: Link ExternalSite:Page text to external sites based on aliases defined in the InterWikis? topic.
• MathModePlugin: This plugin allows you to include LaTeX formatted math in your TWiki pages.
• RenderListPlugin: Render bullet lists in a variety of formats
• SessionPlugin: Stores persistent information (like logon and skin information) in a session on the server identified transparently by ID passed from browser.
• SlideShowPlugin: Create web based presentations based on topics with headings.
• SmiliesPlugin: Render smilies as icons, like  :-) for or  :cool: for
• TWikiDrawPlugin: Drawing editor
• TablePlugin: Control attributes of tables and sorting of table columns
• TreePlugin: Dynamic generation of TWiki topic trees

Check on current Plugin status and settings for this site in TWikiPreferences?.

Common Editing Errors

TWiki formatting rules are fairly simple to use and quick to type. However, there are some things to watch out for, taken from the TextFormattingFAQ?:

• Q: Text enclosed in angle brackets like <filename> is not displayed. How can I show it as it is?
  • A: The '<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '<' instead of '<', and '>' instead of '>'.
    Example: Type 'prog <filename>' to get 'prog <filename>'.

• Q: Why is the '&' character sometimes not displayed?
  • A: The '&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
    Example: Type 'This & that' to get 'This & that'.

-- MikeMannix? - 02 Dec 2001

-- PeterThoeny - 15 Jul 2003

-- ArtemVoroztsov - 08 Jul 2004