Help page

This is the quick help page for Zwiki version 0.61.0 See also the more complete docs at http://zwiki.org , such as the UsersGuide? .

What is this ?

This site is a wiki, a kind of collaborative website, running the Zwiki wiki software. wiki wiki means quick.

Wikis try to make it as simple as possible to write and share useful content, using intuitive page naming and text formatting conventions. Wikis are usually (but not always) wide open and assume a cooperating community. Anyone can edit, add comments, and make new pages on the spot. It is often possible to upload files and pictures and get email notifications as well.

Getting around a zwiki

Zwiki's user interface comes in two main flavours: standard and plone , or it may be customized by site administrators. Some standard links are almost always available, such as "home" for the front page, "contents" for an overview of the wiki, and "changes" for a list of recently-changed pages.

Each page in a wiki has a unique name, most often a WikiName - two or more capitalized words joined together. Free-form names - any word or phrase enclosed in brackets - may also be used here (unless disabled). Wiki page names which appear in text automatically link to that page. Click "backlinks" or the page title or use the "b" access key to see which pages link to this one. You'll also see ordinary links made with bare urls, HTML, text formatting markup, or ZWiki:RemoteWikiLinks .

Some more tips:

• set your time zone, editform height and other things by clicking "options"
• leave your mouse pointer over most user interface elements to see informative tooltips

Page hierarchy

Zwiki keeps pages in a hierarchy, like an outliner, which helps to organize large amounts of content. Unless disabled by the site administrator, you can:

• see the overall wiki outline, by clicking "contents" or using the "c" access key
• see a page's subtopics, if any, linked just below the main text
• go to the next page, the previous page, or up, using the "n", "p", and "u" access keys
• reparent the current page to move it (with subtopics) to a new place in the hierarchy, using the backlinks screen or the page management form at the bottom of the page

Subscribing

If you see a "subscribe" link, you can subscribe to receive comments (or all edits) by email. You can subscribe to individual pages, or to the whole wiki.

1. Click "subscribe"
2. if needed, enter your email address and click "Change"
3. click the button to toggle your page or wiki subscription status

If the site administrator has configured it, subscribers may also send comments by mail. Just reply to a mail from the wiki, or send mail to the wiki's mail-in address. Your mail will go to the page named in brackets in the subject (or to a default page).

Editing

You will be able to create, edit, rename, reparent, delete any page, upload files and images, and more - except where restricted by the site administrator. Many zwikis require that you set a username in "options" before you can make changes. Tips:

• Add a comment using the form at the bottom of the page. Note this may be received by many subscribers - to avoid this, use the SandBox page for tests.
• Click "edit" to change the page's text. You may also be able to rename the page, select the text formatting rules, or upload a file here. It's useful to enter a short "change note" as well.
• When you write a wiki page name in wiki text, it automatically forms a link to that page (remember, free-form names must be enclosed in square brackets).
• If the named page does not yet exist, a ? link will appear; click that when you are ready to create it.

Formatting rules

When you save a page, Zwiki formats and links your text according to some standard markup rules. Different rules are applied depending on the page type; they are described at ZWiki:TextFormattingRules. Here is a quick primer for ZWiki:StructuredText (but zwikis increasingly use ZWiki:RestructuredText which has some differences..).

1. non-blank lines are run together to form a paragraph; paragraphs are separated by blank lines
   
2. a one-line "paragraph" followed by a more-indented paragraph makes a heading. Tip: you need only indent the first line.
   
3. a paragraph beginning with - or a number followed by a space makes a bullet or numbered list item; a more-indented list item starts a sub-list
   
4. short text enclosed in *...* , **...** , _..._ or '...' is italic, bold, underlined or monospaced respectively
   
5. WikiNames, [Free-form name]s enclosed in brackets, ZWiki:RemoteWikiLinks , http://bare/urls , and !Structured Text links are made into hyperlinks
6. HTML tags may be added if necessary; on sites which permit it, DTML (server-side code) may also be used
   
7. short text enclosed in single quotes is quoted, ie displayed in monospace font and protected from some of the above formatting. For reliable quoting of a body of text, indent it after a paragraph ending with a double colon :

          Like this (edit this page to see source).
          This is the surest way to prevent WikiLinks, <HTML tags> and &dtml-tags;
           and preserve
            fixed-width formatting.
   

8. don't worry about learning all the rules and their interactions - just mimic the text around you; when it does something unexpected, try some tweaks; go to the docs or ask for help when you get really stuck or curious about why it's doing something.

Access keys

Here are the access key shortcuts available on a zwiki site. See also http://zwiki.org/QuickReference#access-keys :

        wiki functions:

        f    show front page
        c    show wiki contents
        r    show wiki recent changes
             show discussion page
        t    show issue tracker
        i    show wiki index
        o    show wiki options (preferences)
        h    show help page
        s    go to search field

        page functions:

        +    (in a plone/cmf site with skin switching set up) use zwiki's plone/cmf skin
        -    (in a plone/cmf site with skin switching set up) use zwiki's standard skin
        v    view page
        m    mail subscription
        b    show backlinks (links to this page)
        d    show diffs (page edit history)
        y    show full history (in ZMI)
        e    edit this page
        x    edit with an external editor
             print this page (and subtopics)
        q    view page source (quick-view)
             wipe and regenerate this page's render cache
             go to subtopics
             go to comments (messages)
             go to page author's home page, if possible
        n    next page
        p    previous page
        u    up to parent page

        when editing a page:

        s    save changes
        p    preview

        when viewing page history:

        n    next edit
        p    previous edit

Find out more

About Zwiki: http://zwiki.org

About wiki in general: http://en.wikipedia.org/wiki/Wiki , http://www.c2.com/cgi/wiki?FrontPage , http://www.c2.com/cgi/wiki?EvolutionOfaWikizen