Making it easy to edit web pages is what wiki is about, Let's edit this page - here's how:

  1. click the "edit" link at top right. (It's small; to the left of the pencil.:)
  2. you'll see the page's source text. Make some small change, (e.g. add some text at the top. We'll explain formatting later).
  3. click "SAVE".

You should see your change immediately. Congratulations! You are using the World-Wide Web as it was intended - a two-way medium.

The rest of this page describes other ways to make changes. Before we move on, though, please edit once more and leave this page the way you found it. That's good wiki practice. (If you can't, never mind, wiki gnomes will fix it.)

A word about permissions

On some zwikis, especially public ones, the administrator will have configured permissions so that some or all of the features below will not be available to you. For example, some sites allow anonymous commenting and rating, but require a member login for editing, and a manager login for deleting. Here on zwiki.org you should be able to try out everything, but first you'll need to click options at top right and set the best username. This helps prevent spam.

Creating new pages

Now let's make a page of your own where you can play without disturbing other readers. You'll learn how to rename or delete it later. Use method 1 or 2 below, it doesn't matter which.

Quick Zwiki method: use page management form

  1. Open http://zwiki.org/SandBox in another window.
  2. In the grey page management form at the very bottom of the page, enter a name for your page, eg YourName
  3. Click the create button
  4. Click the create button again.

Plone method: use plone interface (zwikis in CMF/Plone only)

  • When inside a CMF or Plone site, you can also create wiki pages using the add item menu or the folder contents view. This can lead to confusion though, so it's better use method 1 or 2.

You should now be looking at a new, blank wiki page with the name you gave. Use the edit link there to add some text to your page - a brief personal introduction, or anything you like.

That was a long explanation, but after doing it once or twice you can see it's pretty simple.

Comments, for the lazy

A comment is a special kind of edit that's even easier. Go to your test page and:

  1. enter a comment, and optionally a subject, in the form at the bottom
  2. click add a comment.

How to format your text

Wikis generate nicely-formatted web pages from your text by recognizing simple punctuation and indentation. Zwiki supports a number of these text formatting systems. You can choose which formatting rules a page uses by changing the page type field in the edit form.

Tip: you don't really need to learn these up front; just mimic other pages and tweak your text until you get the look that you want. Read the docs when you need to find out exactly *why is it doing &#%! *.

Attention!

the following is being updated/reformatted

reStructured Text (rst)

Since 2006/04, this is the default text markup. It is more powerful, consistent, and documented than Structured Text.

emphasis: 'italic', 'bold'
paragraphs: paragraphs are separated by blank lines
headings: a single line paragraph underlined and/or overlined
lists: a paragraph beginning with -, * or a number
links: word_ for the link, then below on new line .. _word : url
images: .. image:: url (ex: .. image:: svm.jpg)
Structured Text (stx)

Until 2006/04, this was the default page type. It uses Zope's Structured Text formatting rules, which also permit HTML. If enabled, DTML is also allowed and the page type appears as "Structured Text (+ DTML)". Structured Text is simple, intuitive and forgiving but also has quirks and is not actively developed. On most sites it does not allow international characters everywhere.

emphasis: 'italic', 'bold'
paragraphs: paragraphs are separated by blank lines
headings: a single line paragraph followed by a more indented paragraph
lists: a paragraph beginning with -, * or a number
links: "label":url
images: "label":img:url
HTML (html)
This page type applies no formatting rules, but lets the web browser interpret the page text as HTML. If Epoz is installed on the server, pages of this type will appear as "HTML (WYSIWYG)" and use your browser's built-in WYSIWYG editor if available (see below). Otherwise, if DTML may be enabled the page type appears as "HTML (+ DTML)". A HTML-aware external editor may also be useful; for convenience, any <HEAD> section will be ignored.
Plain text (plaintext)
This page type displays text as-is, in a fixed-width font, with no automatic formatting or linking at all.
WikiWikiWeb markup (wwml)

The wwml page type uses the original WikiWikiWebMarkup rules, or close to them.

emphasis: ?
paragraphs: paragraphs are separated by blank lines
headings: ?
lists: ?
MoinMoin markup (moin)

The moin page type uses MoinMoin's markup rules, aside from some things like macros which are not supported. Useful if you are transitioning from or to MoinMoin.

emphasis: ?
paragraphs: paragraphs are separated by blank lines
headings: a single line paragraph beginning and ending with ===
lists: a line beginning with -, * or a number
links: ?
images: ?

Other ways to edit

WYSIWYG editor

As an alternative to formatting rules, Zwiki supports Epoz, a cool wysiwyg HTML editor that works in most web browsers. Try it out at http://zwiki.org/EpozTest/editform . Also..

External editor

External editor is another nifty zope tool which allows you to edit pages with any program - emacs, Frontpage, Mozilla Composer, etc. This is especially useful for large pages. You need to install a small helper app on your computer - see HowToEditPagesWithExternalEditor. Then go to your test page and click the pencil icon at top right to try it out.

Mac OS X users can use ZopeWiki:ZopeEditManager to make all the setup and configuration easy and use a nice GUI client.

FTP, Webdav

If the site administrator has given you ftp or webdav access to the zope server, you can use an ftp- or webdav-aware editor or filesystem to edit pages.

Renaming pages

When you rename a page, all other pages containing wiki links to that page are updated automatically. (Other kinds of hyperlink aren't updated.) Here are two ways to do it:

edit form method

  1. go to your test page and click edit
  2. change the page name field. You must choose a name not already in use.
  3. click save

page management form method

  1. go to your test page, make sure you have configured a username and are in full mode, and scroll down to the page management form at the bottom
  2. enter the new page name in the page management form
  3. click rename

Deleting pages

Again, here are two ways to do it. Note there will be no confirmation step, the page will be deleted immediately. While you're testing, be careful not to delete a useful page such as this one.

edit form method

  1. go to your test page. You should probably make another page which you don't mind deleting, then go there. Click edit.
  2. enter the word 'DeleteMe' as the first line of the page
  3. click save

page management form method

  1. go to your test page, make another scratch page for deleting and go there, make sure you are in full mode. Scroll down to the page management form at the bottom
  2. optional: if you enter a page name, any wiki links which point to the current page will be changed to point to that one (the replacement).
  3. click delete!.

Deleted pages are moved to a special recycle_bin subfolder. You can usually view a deleted page at 'WIKI/recycle_bin/PAGENAME'.

Uploading files and images

You can upload a file to the wiki using the edit form. A link will be added to the current page automatically, or if the file is an image, it will be displayed. Files are kept in the wiki folder; you can link to them from any page.

Recap

You've learned

  • how to create new pages
  • how to add comments
  • a number of ways to edit pages
  • how to make links
  • how to rename a page
  • how to delete a page
  • how to upload files
  • why other zwiki sites may not show these controls

You now know how to help keep any zwiki up to date or to add new content. There's another feature that you will find useful, though, especially in large wikis: page hierarchy.