Login
showWiki Markup Help

Quick Help

Posted by wolf on March 3, 2008 at 10:48; Wiki ID: QuickHelp

Addressing

The hierarchical structure of feeds and entries is directly reflected in the URLs you use to access an entry or feed. In general, URLs that end with a slash point to a feed, while URLs not ending with a slash reference an entry within a feed. For example:

/myfeed/ points to a feed
/myfeed/Entry points to an entry in the feed with the ID "AtomicWikiFeatures".

To access the raw Atom feeds, the URLs should begin with /atom/content/ or /atom/feeds/:

/atom/content/myfeed/ returns the raw Atom feed as stored in the db. Entry contents are not processed for display.
/atom/feeds/myfeed/ returns an Atom feed suitable for viewing with an Atom-enabled news reader. Entry contents are post-processed for display, e.g. wiki markup is transformed into HTML.

Navigating

The navigation bar on the top right of the page displays the position of the current feed or entry in the feed hierarchy. To navigate back to an ancestor feed, click on one of the links.

Creating a new feed/page

To create a new feed, just change the URL in the location bar of the browser and have it point to a non-existing feed. A "page not found" form will be displayed. To create the feed, enter a title and submit the form.

You can also use the navigation bar. Enter the name of the feed into the input box and click on the New Page button. The feed will be created relative to the current feed.

Editing

The editor provides shortcuts to some formatting actions in the toolbar. However, you can also enter Common Wiki markup directly in the text. The Wiki Markup Help box in the sidebar lists some wiki markup syntax examples.

Every entry should have a title and an ID. The ID is used to identify the entry in an URL or link to it. It should be a simple string, only characters, no whitespace. If no ID is specified, the editor will create one from the first 3 words of the title when saving the entry.

Note: Every entry does also have an internal Atom ID, but this one is rather complex and too long to type.

Images and Attachments

Before an image can be embedded into an entry, it has to be uploaded to the feed. This is done through the upload dialog, which opens if you click on the Upload Images link in the Edit menu.

Once an image has been uploaded, you can insert a link to it through the image icon in the editor's toolbar.

Other attachments than images can be uploaded in the same way. After uploading an attachment (e.g. a PDF document), you can link to it from within the entry using a relative URL.

Links
Latest Additions
AtomicWiki 0.1 dev $Id$
,