Emerald Hand Wiki

Wiki - Editing

Modified: 2007/04/13 13:10 by Ornus - Categorized as: Usage, Wiki
For basic help please visit Help section at ScrewTurn Software. It's a good place to start if you are new to wiking.


Edit

Naming convention

Since the wiki doesn't really support sections or structure we need to simulate one through naming. We can do that by using the same prefix for related pages. Use a separator between section/sub-section names to make the name easier to recognize and more pleasing to the eye.

For example Sider-Dev-Tutorials-Type refers to Sider project, Development section, Tutorials sub-section and Type tutorials.

Edit

Syntax

Edit

Relative path

You can create relative links to reference other pages with special path syntax.

With PathElements plug-in for Screw Turn wiki it's possible to use folder-like syntax to generate links to wiki pages. This is convinient to organize pages by different sections. By default name separator is "-" symbol, i.e. Page-SubPage. It's possible to configure this symbol by supplying plug-in configuration.

It's possible to use "/" in link as a separator. It will be changed to "-" when page is processed. "." or initial "/" refers to the current page. ".." refers to the parent page. Plug-in won't fix links with ":" and "@" characters (that's how external links are distinguished from wiki links).

Here's what is possible to do:

The plug-in is free to use, but I provide no support. Use it at your own risk. I haven't really tested it's performance and I'm not sure what impact it will have on your wiki.

I'd like to learn about your experience and any updates you might implement.

Inspired by http://www.openwiking.com/HelpWiki/ow.asp?HelpWiki%2FChildSiblingSyntax

Edit

Additonal syntax

This wiki supports special addition syntax.

For help with the basic syntax please visit the Official help section at ScrewTurn Software. This page describes additional syntax specific to this wiki and available through installed plug-ins (MestemakerPlugins and PageListPlugins).


CategoryIndex

{CategoryIndex} - to show pages in all categories

{CategoryIndex:CategoryName} - to show pages in a specific category. Capitalization doesn't matter.

For example
{CategoryIndex:wiki}
will do:




Code

<code><xmlTag a="value">text

<tag2/>
</xmlTag></code>

Will produce:
<xmlTag a="value">text
<tag2/>
</xmlTag>

You can use the following arguments within the opening tag:

lang (default is xml) = actionscript, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, bnf, c, caddcl, cadlisp, cfdg, cfm, cpp-qt, cpp, csharp, css, c_mac, d, delphi, diff, div, dos, eiffel, fortran, freebasic, gml, groovy, html4strict, idl, ini, inno, io, java, java5, javascript, latex, lisp, lua, matlab, mirc, mpasm, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, php-brief, php, plsql, python, qbasic, reg, robots, ruby, sas, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vb, vbnet, vhdl, visualfoxpro, winbatch, xml

numbers (default is 0) = 0 = no line numbers, 1 = line numbers, 2 = fancy line numbers (every 5th line)

And within the code you can use the following tags to emphasise a line:

<BEGIN GeSHi>important code here<END GeSHi>

See Geshi Code Highlighting for additional information.

CurrentDateTime

{CurrentDateTime}

Will do 2009/01/05 19:22


CurrentDay

{CurrentDay}

Will do Monday


CurrentYear

{CurrentYear}

Will do 2009


MyProfileLink

{MyProfileLink}

Will do My Personal Page


NewestPagesList

{NewestPagesList}
or
{NewestPagesList d|days=X p|pages=Y}

Both days and pages are optional. X is the page age limit in days, Y is number of pages to show. By default page age limit is 7 and all pages will be shown. More info is available http://www.screwturn.eu/forum/viewtopic.php?t=683 here.


{NewestPagesList}
{NewestPagesList days=3}
{NewestPagesList d=4}
{NewestPagesList pages=10}
{NewestPagesList p=15}
{NewestPagesList d=5 pages=10}

December 24, 2008November 05, 2008October 07, 2008September 25, 2008September 10, 2008

RecentUpdatesList

{RecentUpdatesList}
or
{RecentUpdatesList d|days=X p|pages=Y}

Both days and pages are optional. X is the page age limit in days, Y is number of pages to show. By default page age limit is 7 and all pages will be shown. More info is available http://www.screwturn.eu/forum/viewtopic.php?t=679 here.

{RecentUpdatesList} 

{RecentUpdatesList days=3}
{RecentUpdatesList d=4}
{RecentUpdatesList pages=10}
{RecentUpdatesList p=15}
{RecentUpdatesList d=5 pages=10}

January 04, 2009December 27, 2008December 24, 2008November 14, 2008

Relative links

See Path syntax for more info on how to create relative links between wiki pages.

RSS

{RSSDisplayer:URL}

or
{RSSDisplayer:URL|max items}

URL is RSS link and max items is number of items to show.

{RSSDisplayer:http://cs.emeraldhand.com/forums/rss.aspx?ForumID=18&Mode=0|3}

will show

Announcements
Sider news and updates.

  • Move to ScrewTurn wiki complete
    Wed, 21 Mar 2007 23:19:11 GMT »
    I moved all documentation to new ScrewTurn based wiki. Everything should work now. Anybody can register and contribute to it now.


  • Moving wiki to ScrewTurn
    Mon, 19 Mar 2007 21:15:29 GMT »
    Wiki is going to be down while I'm moving it to ScrewTurn. It's more stable and supports important features (such as authentication). The move shouldn't take more than a day or two.


  • Sider 0.5 released
    Fri, 15 Dec 2006 18:19:31 GMT »

    Sider 0.5 Technology Release is ready for download. It's just a demo of the platform and comes with a limited number of extensions. It also has a time-limit and will expire on 04/01/2006. If you decide to check it out, please, write us about your experience.

    This release is just the first step toward completing Sider. We will continue to work, adding new features and support for different types of documents to ensure it is well suited to work with different information. Our current focus is adding support to manage notes and projects.







Reference

{Reference:Text of the reference here} 
is useful for creating word referenced. It is replaced by this. For example {Reference:Text of the reference here}
<cite><a name="_rev1" href="#_ref1" title="Text of the reference here">(1)</a></cite>

and generates this at the bottom
<cite><a href="#_rev1" name="_ref1">1. Text of the reference here</a></cite>{BR}

Thank you to all people who worked on these plug-ins. You can find their source and more information about them at ScrewTurn Forum.

Copyright © 2006-2008 Emerald Hand, Inc. All rights reserved.
Powered by ScrewTurn Wiki version 2.0.34. Some of the icons created by FamFamFam.