Project Theseus
KnowledgeBase

[ WikiHelp.txt ]

| Recent Changes | Find Page | All Pages | Front Page | | | Help |
 


;h1 EpikWebsite Help
**Table of Contents**

[:toc:]

;^
---
;!
;h2 Overview
;{
Wiki's are a quick and easy way of creating web content. EpikWebsite was designed to help make that content look attractive and well organized by adding a few simple formatting characters called "markup tags". For example a word can be made ** bold ** by putting two asterisk characters before and after it. There are a lot of "wiki dialects. EpikWebsite's syntax is called EpikWiki.

You can get an idea how this works by reading the [WikiHelp#Quick Start|] below and then experimenting a little in an area called the "SandBox". Click the Edit button at the top of the **[SandBox|]** page and you can enter text and markup tags... then hit save and you'll see the effect on the SandBox web page.

There is a summary of the markup characters on the editor page. As an example, you can view the wiki markup that created this page by clicking [WikiHelp.txt|here]. There is also a page of [WikiExamples|].
;}
;h2 Quick Start
;{
The easiest way to create a wiki page is to simply type in the text information... then go back over it and add a few markup tags to make the information look nicer on the page. Entering wiki formatting is optional... but just little can make a **big** difference in the attractiveness of a given page! Here are the most useful tags:
;h3 Headings and indenting
;{
Headings and indented text make information look organized. Headings also provide anchors for a formatted table of contents that can be automatically generated. Here's how to do it in EpikWiki markup:
;h3 Headings and indenting
;{
Headings with indented text make information look organized. Headings also
provide anchors for a formatted table of contents that can be automatically
generated. Here's what this text looks like in wiki markup:
;}
The ;h3 makes a heading and the ;{ and ;} indent the block of text. Block commands like these must start at the beginning of a line in order to be recognized.
;}
;h3 Try the SandBox!
;{
There are other markup tags for bolding, underlining and creating more sophisticated pages... but this is all you really need to start creating site documentation. Try out the [SandBox|] to get a real feel for EpikWiki and the way the editing system works. If you want more page features, click "Help" at the top of each page and you'll return to this page. The full EpikWiki tag syntax is described in the rest of this page.
;}
;}
;h2 EpikWiki Markup Tags and Syntax
;{
There are basically two types of markup tags in EpikWiki, those that can appear anywhere in the text and those that must be placed at the start of a line.
;h3 Tags that can appear anywhere
* Two * before and after something makes it ** bold **
* Two _ before and after something __ underlines __ it
* Two ' before and after something makes it ''italic''
* Two vertical bars before and after something puts a ||box around it||
* Three % after an item forces a line break (useful for vertical spacing in lists)
* Three @ will insert a non-breaking space (useful for horizontal spacing)
;h3 Tags that must be placed at the start of a line
* One * before a line makes it an item in a [WikiExamples#Bullet and Numbered Lists|bullet list]
* One # before a line makes it an item in a [WikiExamples#Bullet and Numbered Lists|numbered list]
* Enter a header by typing ;h1 to ;h6. Header text also become anchors.
* Three hyphens (---) will insert a horizonal line
* Start a nested block indent with a ;{ and end it with a ;}.
* Left, centered or right justification is done with ;( @@@ ;^ @@@ and @@@ ;) @@@ respectively. The block is terminated with a ;!
* Html tags can be added after a colon at the start of a line such as :TABLE. See the [WikiExamples#Creating tables and other html block structures|table example] and view the wiki markup on [WikiHelp.txt|this page] for further examples.
* To add pre-formatted text, simply add one or more spaces before it at the start of a line
;{
Procedure Testing;
begin
halt
end;
;}
;;
;; This is a wiki comment line
;; Comments can be used for spacing the wiki source and making it more readable
;;
;;
* Two semicolons (;;) at the start of a line is a wiki comment that won't show on the displayed page. Comments surround these two lines. You can see them in the [WikiHelp.txt|wiki source] for this page.
;;
;;
;; Comments don't show up on the displayed pages
;; They insert no next or line breaks at all
;;
;;
;}
;h2 WikiWords and Links
;{
Links are created to places on a wiki page or to other wiki pages by using WikiWords. Most wiki systems define a WikiWord as two capitalized words with no space between them. This form is sometimes called "Camel Case" because the words appear to be "lumpy". EpikWiki uses a more precise syntax in order to avoid WikiWords accidentally appearing in technical documentation where Camel Case is very common.
;h3 WikiWords
;{
WikiWords in EpikWiki are also Camel Case... but they are also enclosed in brackets with a vertical bar separating the WikiWord from optional text that can be displayed on the web page. The following examples are enclosed in single quotes to keep them from being interpreted as WikiWords:

'[FrontPage|]' - Would show [FrontPage|] and link to FrontPage
'[FrontPage|This is the FrontPage]' - Would show [FrontPage|This is the FrontPage] which links to FrontPage
'[FrontPage#About|]' - Links and indexes to the "About" header on [FrontPage#About|]
;}
;h3 HyperLinks
;{
Fetching pages or images from outside the EpikWiki environment is done with conventional hyperlinks. Links can be typed in directly and will be clickable on the wiki page such as http://theseus.sourceforge.net

Links can also be embedded in a WikiWord bracket structure in order to associate a string with the link on the wikipage. The following example has a missing forward slash to prevent it from being interpreted as a hyperlink:

[http:/theseus.sourceforge.net|Project Theseus Website] will result in [http://theseus.sourceforge.net|Project Theseus Website]
;}
;h3 Inline Images
;{
Web based or local images can be loaded inline or linked by enclosing them in brackets per the following examples. They are also missing a forward slash to prevent interpretation but you can click [WikiHelp.txt|here] to see the source for this page.

**[http:/theseus.sourceforge.net/kb/logo.png]** would **load** the image inline [http://theseus.sourceforge.net/kb/demo.gif|] as this illustrates.

Rather then loading the image, you can create a clickable link to it:
**[http:/theseus.sourceforge.net/kb/demo.gif|click here]** would load the image if you [http://theseus.sourceforge.net/kb/demo.gif|click here].
hello, this is an inline image [http://theseus.sourceforge.net/kb/demo.gif|]

**[file:/demo.gif|]** will load the image from the local directory:[file://demo.gif|].

**[file:/demo.gif|clickable]** will create a [file://demo.gif|clickable] link to a local copy of demo.gif.

You can also include styles, and other attributes along with the graphic:
**[file:/demo.gif alt="" style="width: 30px; height: 31px;" align="middle"|]**

Would align the graphic [file://demo.gif alt="" style="width: 30px; height: 31px;" align="middle"|] in the middle of this line's text.
;}
;h3 Cascading Style Sheets (CSS)
;{
EpikWiki supports optional custom css sheets that can be specified on each page and edited using the EpikWebsite editor. This is a beta 3 feature under test... but the current syntax is !!;classname <text that the class is applied to> !!;! The last escape sequence terminates the span with a "</div>". This syntax hasn't been finalized but it's currently available in all versions.
;}
;}
;h2 Special embedded commands
;{
EpikWiki provides some special functions that can be embedded and executed from any page. A special command has the format of '[:Command:]' without the single quotes. The following are supported:
* '[:toc:] generates a table of contents (TOC) from all the heading text on the current page.
* '[:toc=SomeWikiPage:]' generates a TOC of the specified page on the current page.
* '[:css=customstyle.css:]' include a custom css stylesheet to apply to this page.
* '[:recentchanges:]' lists the files that have changed over the last two days.
* '[:findpage:]' brings up a page or content oriented search entry form.
* '[:allpages:]' lists all the pages currently in the wiki knowledgebase.
Functions that can only be entered by the administrator
* '[:usernotes=+:]' overrides the global default and enables user notes for that page.
* '[:usernotes=-:]' overrides the global default and disables user notes for that page.
If a css style sheet is not specified, default.css is always used. If a style sheet is specified, default.css will be replaced. Multiple style sheets can be applied to the same page.
;}


Last modified on November 1, 2003 at 06:36:21-UTC

Powered by EpikWebsite

This Project is generously hosted by SourceForge.net Logo


Page created in 0.027404 seconds