This is a DistributionDocument. Please help maintain high quality documentation:
This is a wiki, please fix the documentation
if you find errors or incomplete content. Put questions and suggestions concerning the documentation
of this topic in the comments section below
. Use the Support
web for problems you are having using
TWiki Shorthand Basics
If you can enter text, you're ready for TWiki. With a few simple, intuitive TextFormattingRules
, you'll be able to use plain text to create well-styled postings, instantly. Here's a fast-track guide to shorthand basics...
Related topics: WikiSyntaxSummary
- Separate each paragraph with a blank line.
- To display a word or phrase in bold type, put it in asterisks:
- To display a word or phrase in italic, put it in underscores:
- To display a word or phrase in bold italic, put it in double underscores:
- To link to another Wiki topic, type the WikiWord for that topic. To link to a Wiki topic in another web, type the name of the web, and a dot, first:
- If you enter a WikiWord for a topic that doesn't exist, it'll appear highlighted with a red-link, prompting you (or someone else) to start off the new topic by clicking the link - NewTopic (click the link, but don't save, to preserve the example!).
- When entering WikiName signatures - like, guest - include "Main." as a prefix, since all TWiki member pages are in the Main web:
- For an external link, type the full URL:
- To prevent a WikiWord from becoming a link, type
<nop> or an exclamation point first:
- To indent with a bullet, enter
- Use multiples of 3 spaces to start nested bullets.
- To create a numbered list:
- Start items in a numbered list with
- The "1" (or any number) will be replaced by the correct number, in order.
- To add a new paragraph without restarting list numbering, use the %BR% variable, like below:
Text added (in new paragraph)
- and list numbering continues.
- Always start counting spaces for bullets and such from the beginning of a new line.
- To include an image, type its URL. You also can Attach an image to the page and display it with text
- To display a word or phrase in
MONOSPACED TYPE, put it in equal signs:
==two== for bold:
<verbatim> to enclose code excerpts, filenames, and other unformatted text:
NOTE: VARIABLES can be set within verbatim tags, that is, they are not disabled
<literal> to enclose anything that TWiki must not touch under any circumstances, such as in-line HTML code.
- Follow GoodStyle recommendations when editing topics.
- See TextFormattingRules for the complete set of formatting rules.
Comments & Questions about this Distribution Document Topic
Is there any functional difference between verbatim and pre at this point in time? If so, maybe we should mention verbatim as an alternative. (I switched from pre to verbatim but don't recall exactly why, but it seemed to solve a problem I was having at the time.) PS: I'll delete this note and the response when I see it.
- 02 Dec 2001
I removed verbatim from the example 'cause I was...sleepy. I removed it, actually, because of that, and also because this is a quick start page - people may not even know HTML, pre PLUS verbatim is probably confusing here, people needing verbatim would look in TWikiShorthand
... WDYT? (Also, as the titles get shuffled around, and rewrites slowly happen, the point approaches where are the User's Guide stuff will get edited down and some pages combined, since there's a fair bit of redundancy here right now. Again, WDYT?) That's the reason (and rough plan)... Comments?
(Thanks for the copy editing here and there!!)
You're welcome! -- rhk
- 02 Dec 2001
"verbatim" displays the intervening text as-is. With "pre", HTML tags are interpreted. The example above takes advantage of this difference to make things bold.
- 04 Dec 2001
If we don't want to list both "pre" and "verbatim" (which is fine), I think the change from "pre" to "verbatim" is the best approach (as it is now). With that said, I have no problem with any or all of my comments being deleted from this page.
- 05 Dec 2001
Honestly, I think if one is mentioned, the other one should be too. It's a significant distinction, and could be frustrating for someone who's expecting one thing, and gets something else. On the other hand, if only one is to be mentioned, I think "verbatim" is better since it lets people write example HTML code.
- 08 May 2002
I think they should both be mentioned - the PRE could perhaps be left for an 'advanced features' page if there is too much for the basic syntax page.
- 09 May 2002
Wow, I'm used as part of the example. Interesting, and a bit spooky.
- 15 Jul 2002
Added: how to insert paragraph into numbered list without breaking numbering.
- 03 Jan 2003
Seems like the this topic (WikiSyntax
) and the TextFormattingFAQ
topic are somewhat overlapping. There really should be a single approach to explaining the basics of editing topics. If there's still a need for 2 topics, they should reference each other and avoid overlap of steps to perform specific actions.
- 17 Dec 2004
WikiWord linking can also be prevented by prepending an exclamation point.