| | |
|
TextFormattingRules 34 - 05 Jun 2002 - Main.PeterThoeny
|
| |
TWiki Text Formatting | | | | |
<
< | At least three dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading; the maximum is level 6. Note: A Table of Content can be created automatically with the %TOC% variable, see TWikiVariables. | >
> | At least three dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading; the maximum is level 6. Note: A Table of Content can be created automatically with the %TOC% variable, see TWikiVariables. Any heading text after !! is excluded from the TOC; for example, write ---+!! text if you do not want to list a header in the TOC. | | | | | | | |
<
< | | >
> | | | | Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
Note: Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.
| | | | | |
<
< | | | | Using HTML |
|
|
TextFormattingRules 33 - 02 May 2002 - Main.PeterThoeny
|
| |
TWiki Text Formatting | | |
-
- 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 TWiki.
-
%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 TWiki web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%
- TWikiPreferences defines site-wide variables like colors. For example, write:
%RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
| | | TWikiPlugin Formatting Extensions | | | Check on current Plugin status and settings for this site in TWikiPreferences. | |
<
< | -- MikeMannix? - 02 Dec 2001 | | | | |
<
< | Updated to cover TWiki:Codev/EasierExternalLinking (in the alpha release). | >
> | 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: | | | | |
<
< | -- RichardDonkin? - 26 Mar 2002 | >
> |
- 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>'.
| | | | |
<
< | Latest updates to this topic are in the main TWiki, since that's got the TWikiAlphaRelease code. | >
> |
- 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'.
| | | | |
<
< | -- RichardDonkin? - 05 Apr 2002 | >
> | -- MikeMannix? - 02 Dec 2001
-- PeterThoeny? - 02 May 2002 |
|
|
TextFormattingRules 31 - 26 Mar 2002 - Main.RichardDonkin
|
| |
TWiki Text Formatting | | | | |
>
> | Easier External Links:
An easier syntax for external links is now available: [[externalURL text]] - just hit the spacebar to separate the link URL from the descriptive text, e.g. [[http://gnu.org/ GNU]]. This also supports anchors, e.g. [[http://www.yahoo.com/#somewhere Yahoo!]].
[[http://gnu.org GNU]]
|
GNU
|
| | | | Anchors:
You can define a link reference inside a TWiki topic (called an anchor name) and link to that. To define an anchor write #AnchorName at the beginning of a line. The anchor name must be a WikiWord. To link to an anchor name use the [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.
| | | |
- Email addresses like
name@domain.com are linked automatically.
| |
>
> |
-
- 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.
| | | TWikiPlugin Formatting Extensions | | | Check on current Plugin status and settings for this site in TWikiPreferences.
-- MikeMannix? - 02 Dec 2001 | |
>
> | Updated to cover TWiki:Codev/EasierExternalLinking (in the alpha release).
-- RichardDonkin? - 26 Mar 2002 |
|
|
TextFormattingRules 30 - 03 Dec 2001 - Main.MikeMannix
|
| |
TWiki Text Formatting | | | Using HTML | |
<
< | You can use just about any HTML tag without a problem - however, to keep in mind: | >
> | 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 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.
- NOTE: The standard installation TWiki is compatible across a wide range of browsers and computer platforms. If this is important to you, remember that using browser-specific tags or any other mark-up that doesn't degrade well will reduce compatibility.
| >
> |
-
 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 |
|
| Revision 34 | r34 - 05 Jun 2002 - 01:27:00 - PeterThoeny? |
| Revision 33 | r33 - 02 May 2002 - 21:41:50 - PeterThoeny? |
| Revision 32 | r32 - 05 Apr 2002 - 13:36:49 - RichardDonkin? |
| Revision 31 | r31 - 26 Mar 2002 - 08:26:34 - RichardDonkin? |
| Revision 30 | r30 - 03 Dec 2001 - 04:11:51 - MikeMannix? |
| Revision 29 | r29 - 02 Dec 2001 - 08:07:19 - MikeMannix? |
|
|
|
This site is powered by the TWiki collaboration platform.
All material on this collaboration platform is the property of the contributing authors.
All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.
|
|
| | |