Last change: 05/05/10 12:47 | Log in
Plainsaw Help

Text Formating, Linking, and Tables

Wiki pages are edited as plain text. This text can be marked up in various ways to determine how it will display after you click the Done button.

To create a new page, simply make a wiki page link (see below) to the new page, then click on the link and you will get an empty editing form. Links to wiki pages appear in two colors:
  • main link color (default: green) - existing wiki page
  • alternate color (default: orange) - a new wiki page
To edit a new or an existing page, click on the Edit Page link at the bottom of the page.

TEXT FORMATING
Linebreaks (normally created by the Return or Enter key) are just that - linebreaks. Flowing text (where you don't press Enter) will be word-wrapped to fit the viewing window. Use two linebreaks between paragraphs.

Markup
Example
Comments

''some text''
some text
italics - two single quotes before and after the text.

'''some text'''
some text
bold - three single quotes before and after the text.

==1some text==1
some text
text highlighting. accent color set in the span.one class.

==2some text==2
some text
text highlighting. accent color set in the span.two class.

==ssome text==s
some text
reduces text size from normal size. set in the span.small class.

!some text

some text

small heading (the <h1> tag).
- the exclamation point must be the beginning of a line in the edit box.
- a linebreak ends the mark-up's effect.
!some text: this works
    !some text: this doesn't - there's a space before the exclamation point.

!!some text

some text

medium heading (the <h2> tag).

!!!some text

some text

small heading (the <h3> tag).

^character
Shift - 6 key
this is the "escape" character.
- use it before a mark-up character to make the character display.
- example: ^[ to display a square bracket like this [.

{some text}
some text

this will preserve, for the most part, the exact layout of text.
- meant to be used for the display of code samples.

{{{some text}}}

use this mark-up to hide comments within an article.
- will appear in edit mode, but not in view mode.
- can be used to add keywords (tags) to articles.

You can mix these mark-ups together. Here's some examples.

Markup
Example
Comments

'''''some text'''''
some text
five single quotes before and after - combining italics and bold.

'''==2some text==2'''
some text
combining bold and an accent color.
- nest the mark-up properly, i.e. avoid '''==2some text'''==2.

!!==1some text==1

some text

combining a heading with an accent color.
- the exclamation point(s) must come first.

Hint: the heading mark-ups, per the html spec, have padding above and below the text, so you don't need to use additional linebreaks to create extra white area. This can be adjusted in the style sheet if you like.
Hint: rather than having three sizes of headings, consider adjusting the heading tags in the style sheet so that you have the same size heading in different colors.
Troubleshooting: other than the heading mark-up, you've got to put the mark-up before and after the text.

TEXT STRUCTURE

Markup
Example
Comments


<space>
puts a space at the beginning of a line indents the line.
    like this.

%%some text
some text%%
some text
some text

indent block of text.
<blockquote>

*some text
*some text
**some text
**some text
*some text

  • some text
    • some text
    • some text
  • some text
bulleted list.
- the * must be at the beginning of a line, like the heading mark-up.
- bulleted lists can nest to three levels.
*some text: this works
    *some text: this doesn't - there's a space before the star.

#some text
#some text
#some text

  1. some text
  2. some text
  3. some text
numbered list.
- the # must be at the beginning of a line, like the heading mark-up.
- only one level of numbering at this time.

----

horizontal rule line - four dashes alone on a line.

LINKING

Markup
Example
Comments

[wiki page name]
wiki page name
this will create a link to another wiki page.
- only include the name of the page; do not include the .txt extenstion.
- if the link is in the main link color (default: green), the article already exists.
- if the link is in the alternate color (default: orange), it is a new article.

[text:wiki page name]
text
this will create a link to another wiki page with text portion is the descriptive display for the link.
- only include the name of the page; do not include the .txt extenstion.
- if the link is in the main link color (default: green), the article already exists.
- if the link is in the alternate color (default: orange), it is a new article.

full url
http://www.plainsaw.org
if you enter the fully qualified url of a page, it will display as a link.
- you must include the http:// part or the url.

[text|full url]
Plainsaw
text portion is the descriptive display for the link.
full url is the fully qualified link, and must include the http://.

[text!full url]
Plainsaw
text portion is the descriptive display for the link.
full url is the full link, including the http://.
- this will open the link in a new window (or tab).

email address
nospam@inta.org
will display an email address as a link.
- not recommended if you are concerned about spammers harvesting addresses.

[|text|file name.ext|]
test txt file

test zip file
text portion is the descriptive display for the link.
file name.ext is the full name of the file, including extension.
- the file must be in the STORE_DIR folder.
- this link does not display the contents of the file in the wiki. It is a link for downloading (or displaying on an unformatted page, depending on type of file).

[%text|image.ext%]
[%text|full url%]
test image

"image-one" style; default 1px border.
text portion is used to fill the <alt=""> attribute of the image.
image.ext is the full name of the graphic, including extension.
full url is the full link, including the http://.
- the file must be in the STORE_DIR folder.

[%text!image.ext%]
[%text!full url%]
test image

"image-two" style; default no border.
text portion is used to fill the <alt=""> attribute of the image.
image.ext is the full name of the graphic, including extension.
full url is the full link, including the http://.
- the file must be in the STORE_DIR folder.

TABLES

Markup
Example
Comments
{||
<table class="one">
    <tr><td>
start a table with "table.one" style.
- default: 1 pixel border.
- this opens a table and the first row and cell of the table.
{%|
<table class="two">
    <tr><td>
start a table with "table.two" style.
- default: no border.
- this opens a table and the first row and cell of the table.
|||
</td></tr>
    <tr><td>
a new table row - closes the preceding cell and row and begins new ones.
||
</td>
    <td>
a new cell within a row - closes the preceding cell and opens a new one.
||}
</td></tr>
    </table>
ends the table. Closes the preceding cell and row and closes the table.
- Make sure you end the table!
- if the page layout breaks, it's probably because there's no ||}
{|| => {|%xx|
{%| => {%%xx|
||| => ||%xx|
|| => |%xx|
<td some text>
allows insertion of html or style mark-up within a table cell.
- xx respesents the inserted text.
- insert % and then the text before the last | in the mark-up.


Table mark-up can be all on one line, or can be separated by line breaks. Both of these examples are ok:

1. {|| some text || some more text
2. {|| some text
    || some more text

Here's the mark-up for the legend row at the top of all these tables as an example showing the inclusion of the style mark-up:

    {|%style='font-size: 0.7em; text-align: center; width: 150px;'| Markup
    |%style='font-size: 0.7em; text-align: center; width: 150px;'| Example
    |%style='font-size: 0.7em; text-align: center;'| Comments