$vval) { global $$vname; $$vname = $vval; // echo $$vname . "=" . $vval; } } } /* uncommented the first line, commented the second line, to get captchas to work. -Kevin Finity, 11.02.06 */ session_start(); //set_globals(); ?> CU2C2-Board - TextFormattingRules

TextFormattingRules

To Do List

Agenda

Proposals

Promotions

Conference

Finance

Minutes

By-Laws



CU2C2 Board Wiki Home | Top | Bottom | Contacts

Top | Bottom

SWIM: Style | Target Anchors | Headers & Footers

Standard: Paragraphs | Lists | Headings | Fonts | Indents | Emphasis | References | HTML


New Text Formatting Rules for SWIM

Style

  • Although it is easy to create new pages for every workshop, event, or participant, we ask that information be grouped onto a single page whenever grouping will help readers find the information that they are seeking.
  • From time to time, the websitistas may combine pages to simplify the wiki.

Target Anchor Tags

  • Linking to subtopics that are grouped on a page is easier with a target anchor tag.
  • To make a target anchor tag, go the the title for the subtopic on the "Edit" page and put a shorthand term, starting with a number sign, in brackets above or on the same line as the title. This will be the destination point for links to this subtopic.
  • For instance, to link to the paragraph below about tables, you could mark the destination with this anchor tag: [#tables]. This anchor won't show up on the finished page.
  • To link to the same tag, you make a normal link, but add a # and the anchor name to the name of the page:
 [TextFormattingRules#tables] or
 [Text Formatting Rules for Tables|TextFormattingRules#tables].

Headers and Footers

  • Perhaps next year, this will be automated.
  • In longer text, it's nice to be able to jump to the top or bottom of the page.
    • Insert this code a the top of the page:
 [#top] [Top | PageName#top] | [Bottom | PageName#bottom]
  • Insert this code a the bottom of the page:
 [#bottom] [Top | PageName#top] | [Bottom | PageName#bottom]
  • Q: Why put both Top and Bottom links together? Isn't the user already at the top or bottom of the page?
  • A: It's easier for casual users to understand what the links do.
  • With pages containing subtopics, it's nice to be able to jump to a specific point on the page from the top and bottom of the page.
    • This page uses code like this at the top and the bottom of this page:
 [ Style | TextFormattingRules#style ] |
 [ Target Anchors | TextFormattingRules#target ] |
 [ Headers & Footers | TextFormattingRules#headersandfooters ]
  • The code above creates the following links:

Style | Target Anchors | Headers & Footers

  • It's also nice to be able to look at previous years. If not for you, then at least for the search engines!
    • This code in our wiki format links to the past seven years of SWIM online!
 Archives:
 [1999|http://www.swimuu.org/swim1999]  |
 [2000|http://www.swimuu.org/swim2000]  |
 [2001|http://www.swimuu.org/swim2001]  |
 [2002|http://www.swimuu.org/swim2002]  |
 [2003|http://www.swimuu.org/swim2003]  |
 [2004|http://www.swimuu.org/swim2004]  |
 [2005|http://www.swimuu.org/swim2005]
  • And looks like this:

Archives: 1999 | 2000 | 2001 | 2002 | 2003 | 2004 | 2005

Tables

  • Here's a small example table. Click "Edit this page" at the bottom of the page to see how it was made.

cell #1 cell #2 cell #3
cell #4 cell #5 cell #6
cell #7 cell #8 cell #9


Standard Features

Paragraphs

  • Don't indent paragraphs
  • Words wrap and fill as needed
  • Use blank lines as separators
  • Four or more minus signs make a horizontal rule
  • %%% makes a linebreak (in headings and lists too)

Lists

  • asterisk for first level
    • asterisk-asterisk for second level, etc.
  • Use * for bullet lists, # for numbered lists (mix at will)
  • semicolon-term-colon-definition for definition lists:
term here
definition here, as in the <DL><DT><DD> list
  • One line for each item
  • Other leading whitespace signals preformatted text, changes font.

Headings

  • '!' at the start of a line makes a small heading
  • '!!' at the start of a line makes a medium heading
  • '!!!' at the start of a line makes a large heading

Small Heading

Medium Heading

Large Heading

Fonts

  • Fonts are standardized in thge cascading style sheets file.
  • Indent with one or more spaces to use a monospace font:
 This is in monospace

This is not

Indented Paragraphs

  • semicolon-colon -- works like <BLOCKQUOTE>
this is an indented block of text

Emphasis

  • Use doubled single-quotes ('') for emphasis (usually italics)
  • Use doubled underscores (__) for strong emphasis (usually bold)
  • Mix them at will: bold italics
  • Emphasis can be used multiple times within a line, but cannot cross line boundaries:

''this will not work''

References

  • Hyperlinks to other pages within the Wiki are made by placing the page name in square brackets: this is a page link? or UsingWikiWords (preferred)
  • Hyperlinks to external pages are done like this: http://www.wcsb.org/
  • You can name the links by providing a name, a bar (|) and then the hyperlink or pagename: PhpWiki home page - the front page
  • You can suppress linking to old-style references and URIs by preceding the word with a '!', e.g. NotLinkedAsWikiName, http://not.linked.to/
  • [1], [2], [3], [4] refer to remote references. Click EditLinks on the edit form to enter URLs. These differ from the newer linking scheme; references are unique to a page.
  • Also, the old way of linking URL's is still supported: precede URLs with "http:", "ftp:" or "mailto:" to create links automatically as in: http://c2.com/
  • URLs ending with .png, .gif, or .jpg are inlined if in square brackets, by themselves:

HTML Mark-Up Language

  • Don't bother
  • < and > are themselves
  • The & characters will not work
  • If you really must use HTML, your system administrator can enable this feature. Start each line with a bar (|). Note that this feature is disabled by default.

SWIM: Style | Target Anchors | Headers & Footers

Standard: Paragraphs | Lists | Headings | Fonts | Indents | Emphasis | References | HTML

Archives: 1999 | 2000 | 2001 | 2002 | 2003 | 2004 | 2005

Top | Bottom

CU2C2 Board Wiki Home | Top | Bottom | Contacts