To add information to the WIKI

How to use the Wiki



Why a Wiki?

  1. Wikis are the most efficient way of collecting and spreading information, editing and updating it.
  2. There are so many features in TurboCAD, no single user can know all problems or areas of the application, but many different users can.
  3. A wiki is a better way of archiving the solutions than a mailing list or a forum.
  4. Everyone can quickly and easily participate with new content, knowledge, ideas and translation or correct bad links, mistakes, typos and spelling errors.

How to Edit or Add Content


When you want to edit a page, just click on the edit button on the top of the page. The Wiki quick help tag at the top of the Edit window opens a Help window below the current window with a condensed version of the formatting rules shown below.

If you want to name a topic that you want to expand on, just include it in double brackets, ((like this)) and the wiki will create a temporary link with a question mark following it. If you click on the question mark, the wiki will automatically create a new page.

If you want to test your Wiki skills first, or just play with it, follow the Sandbox link on the main menu after you've logged on.

Text

Italic Text

Use two apostrophe's before and after a ''word(s)'' to create italics

Bold Text

Use two underscores before and after a __word(s)__ to create bold text

Use both before and after a __''word(s)''__ to create bold-italic text

Underlined Text

3 equal signs before & after ===text=== underlines text

Colored text

Colored text uses 2 tildes followed by the name of a color, a colon (:) to denote the start of the text and finally 2 tildes to end the colored text. Color names should be one word. Instead of the color name, an HTML color number may be used; a pound sign and 6 digits.
"~~forestgreen:some text~~, ~~#FF7E00:some text~~" will display text using the indicated color name or HTML color.
some text~~, ~~#FF7E00:some text

Centered Text

"::centered text::" Will display the text centered
centered text

Non-parsed Text

" ~np~ data ~/np~ " Prevents parsing data

Special Characters

Any of the characters in the ASCII table can be added to a wiki page by enclosing it's number within a pair of tildes.
~0177~ , ±
~0215~ , ×
~0216~ , Ø
~0248~ , ø, etc.
Characters copied and pasted from the Character Map program may also work, but if you get a series of question marks after saving (?????), then you need to use the tilde's with a code number.

Monospaced Text

Start a new line with one or more empty spaces before the text. The Minus (-) and Plus (+) character combination can also be used to specify Monospaced Text.
-+some Monospaced Text+-
some Monospaced Text

Wiki References

Links to a wiki page on the same server requires two open brackets (( before the page name and two close brackets )) at the end of the page name.
((Link Page)) or ((Link Page|description)) for wiki references.
JoinedCapitalizedWords will create a link to a wiki page.
Reversed brackets ))SomeName(( or non-parsing ~np~SomeName ~/np~ prevents referencing.
use square brackets for an external link: [URL] or [URL|link_description] or [URL|description|nocache].

Images

Images can be inserted into text using a syntax similar to the HTML syntax, but using left { and right } curly brackets to enclose the image. For pictures located on-site, you can use {picture file=img/wiki_up//Example.gif}.
Off-site, you can use {img src=http://www3.turbocadcommunity.com/img/wiki_up//Example.gif}. Centering tags :: were applied to Example.gif below.


height=?, width=?, desc=?, link=?, align=? and valign=? are optional. The alignment options cannot be used with the desription option (desc). A space is used to separate the various options; no pipe or slash mark is needed. The description option (desc) has to be one word or connected in some way, if more_than_one_word.

{img src=http://www3.turbocadcommunity.com/img/wiki_up//Example.gif align=center width=120 height=30}

{img src=http://www3.turbocadcommunity.com/img/wiki_up//Example.gif width=60 height=15 desc=Example_Picture}
Example_Picture

Thumbnails

Display a thumbnail that pops up to a full size image upon mouseover.
  • max: indicates the max width or height (whichever is higher) of the thumbnail (default 84).
  • float: none (default), left or right; to make the text wrap around the thumbnail if wanted.


{thumb image="img/wiki_up/LensFlare_Lens35.png" max="100" float="left"}





Use the syntax below to create a clickable thumbnail that opens in the same window. It's best to specify sizes in pixels instead of a percentage. Sometimes a percentage appears to work, but most times the image comes out larger.
[http://www3.turbocadcommunity.com/img/wiki_up//LensFlare_Lens35.png|{img src=http://www3.turbocadcommunity.com/img/wiki_up//LensFlare_Lens35.png width=140 height=140}]



Non cacheable images

{img src=http://www3.turbocadcommunity.com/img/wiki_up//Example.gif?nocache=1}
Height, width, desc, link, align and valign are optional. Alignment options don't seem to work.

Drawings

{draw name=foo} creates the editable drawing foo

RSS feeds

"{rss id=n max=m}" displays rss feed with id=n maximum=m items

Paragraph tags

Headlines

Exclamation points before text "!", "!!", "!!!" create headings
!1 Exclamation point
!!2 Exclamation points
!!!3 Exclamation points

1 Exclamation point

2 Exclamation points

3 Exclamation points

4 Exclamation points
5 Exclamation points
6 Exclamation points

Use the {maketoc} feature to create a simple table of contents from all the various headings ( "!", "!!", "!!!" ) on a page.

Headlines with expandable area

An Expandable Area is created by adding a Plus (+) or Minus (-) character after the Exclamation Marks. The Plus (+) and Minus (-) characters define what the default value is for the expandable area.

!!!+Exclamations with plus + Example

Exclamations with plus + Example

[-]
In either case, the Expandable Area extends to the next headline. When used, a [+] or [-] button is created that, when clicked, will expand or contract the area.

Exclamations with minus - Example

[+]

Title bar

A minus & equal sign before and an equal sign & minus sign after text, "-=Title Bar=-" creates a title bar.
Title Bar

::-=Title Bar with Center tags=-::
Title Bar with Center tags

Horizontal Rule

3 minus signs --- make a horizontal line

Simple box

A caret ^ before and after text, "^Box content^", creates a box with the data
Box content

Plugin Box

{BOX(title=>::Plugin Box::,bg=>color,width=>pixel number or percentage%)}
Text inside box%%%Second line of text
{BOX}
CSS Style Sheet needs to be changed to improve the small "Title" in a box.
Plugin Box
Text inside box
Second line of text

Tables

Two pipes start a Table, end a Table and end every Row. A single pipe separates columns. No line breaks/carriage returns allowed.

||row1-col1|row1-col2|row1-col3|row1-col4|row1-col5||row2-col1|row2-col2|row2-col3|row2-col4|row2-col5 (-+remove line break here+-)
||row3-col1|row3-col2|row3-col3|row3-col4|row3-col5||row4-col1|row4-col2|row4-col3|row4-col4|row4-col5 (-+remove line break here+-)
||row5-col1|row5-col2|row5-col3|row5-col4|row5-col5||

row1-col1row1-col2row1-col3row1-col4row1-col5
row2-col1row2-col2row2-col3row2-col4row2-col5
row3-col1row3-col2row3-col3row3-col4row3-col5
row4-col1row4-col2row4-col3row4-col4row4-col5
row5-col1row5-col2row5-col3row5-col4row5-col5

Multi-page pages

Use 3 periods before & after the word ..."page"... to separate pages. Quotes not needed on the word "page".

img/wiki_up//Page break.png


A page break should be on its own line. It does not come into effect until the article being created/edited is saved.

Lists

Use an asterisk * for bulleted lists
Use the pound sign # for numbered lists

* bullet lists,
** bullet lists,
*** bullet lists,
**** bullet lists,
***** bullet lists,
***** bullet lists,
***** bullet lists,

  • bullet lists,
    • bullet lists,
      • bullet lists,
        • bullet lists,
          • bullet lists,
          • bullet lists,
          • bullet lists,

# numbered lists,
## numbered lists,
### numbered lists,
#### numbered lists,
#### numbered lists,
#### numbered lists,

  1. numbered lists,
    1. numbered lists,
      1. numbered lists,
        1. numbered lists,
        2. numbered lists,
        3. numbered lists,

Text Continuation

Text can be forced to continue at the same indentation level in a list without having a bullet or a Number assigned to it. This is accomplished by having a Plus (+) character start each line. The number of Plus characters controls the indentation level.

*This is a Level 1 item.
+This line begins with a single Plus character
**This is a Level 2 item.
++This line begins with 2 Plus characters
*Back to Level 1.

  • This is a Level 1 item.
    This line begins with a single Plus character
    • This is a Level 2 item.
      This line begins with 2 Plus characters
  • Back to Level 1.

Hidden Details in Lists

An expandable area allows you to display the major items in your list by default. Every item is still there, but it needs to be expanded to become visible. An expandable area is created by adding a minus (-) character after the star (*) characters.

*This is a Level 1 item.
*This Level 1 item has Hidden Details. Click the Plus [+] to open it.
**-This is a Level 2 item. Clicking the Minus [-] will close it.
**This Level 2 item did not need the minus character.
*Back to Level 1.

  • This is a Level 1 item.
  • This Level 1 item has Hidden Details. Click the Plus + to open it.
    [+]
  • Back to Level 1.

Definition list

It uses the semicolon (;) at the beginning of the line and the colon(:) to separate the term from its definition.
;Definition Term:definition for definiton lists
Definition Term
definition for definiton lists

Dynamic content

"{content id=n}" Will be replaced by the actual value of the dynamic content block with id=n

Dynamic variables

"%name%" Inserts an editable variable

For more information on the Wiki concept, refer to the Wiki encyclopedia (external link)
For more information on the TikiWiki syntax, go to: http://doc.tikiwiki.org/tiki-index.php?page=Using%20Wiki%20Pages&redirectpage=Wiki%20Syntax (external link)Using Wiki Pages/url

Contributors to this page: jrsollman , admin and mauritz .
Page last modified on Thursday 26 of August, 2010 06:36:15 PDT by jrsollman.