Wiki Reference

Although you could easily refer to Dokuwiki syntax for editing, this page will serve newbie that wants a clean and easy quick start.

Ths reference will be specific for HoverEX Wiki and we will shows the standard way on how we used the wiki and plugin syntax.

How To

Create a Page

  • a Namespace?
  • a Page?
  • or a Section?
  • Avoid creating new namespace, use existing one, such as dev
  • Use underscore “_” for page, such as visual_identity
  • Create new page only when it is necessary, it is always good to growth from section
  • When section overwhelming, then only spread out to a new page
  • Create a link with the new page name, then click it to create the contents.

Headline

====== Header 1 ======
===== Header 2 =====
==== Header 3 ====
  • Start a page with header 1
  • Header 1 and Header 2 come with a nice bottom line
  • Creating a header is creating a new section as well

Paragraph

This is first paragraph

This is second paragraph
  • Just hit your ENTER key twice to create a new paragraph
  • Make data readable, avoid force paragraph “\\”

Make a Link

Internal links are created by using square brackets. You can either just give
a [[pagename]] or use an additional [[pagename|Title Text]]. Wiki pagenames
are converted to lowercase automatically, special chars are not allowed.
  • Avoid creating new namespace
This links to [[:visual_identity#icon|Icon section in Visual Identity]].

Insert Comments

/* hidden comments go here... */
  • A cool feature in wiki that programmer likes
  • Use it to comments your contents only, do not use it for secure hidden message
  • It will still shown up in the wiki page source

Insert Programming Code

#include "../FrameHandler/FrameHandler.h"
 
class HX_App : public CL_ClanApplication 
{
public:
	CL_DisplayWindow *window;
 
public:
    HX_App(){};
 
    ~HX_App(){};
 
    virtual int main(int, char **);
 
	// main game loop
	void game_loop(void);
 
	void gui_loop(void);
 
	void in_game_loop(void);
 
public:
	CL_Slot slot;
 
	FrameHandler frame_handler;
 
};
 
#endif
  • Almost all HoverEX code is written in C++ code.
  • Use <code cpp> and </code> tag to markup the .cpp and .h source code
  • Wiki system will automatically render into syntax highlighting output
  • Do not submit your patch code here, please use the SourceForge CVS

Insert Image

{{logo.raw.512x512.png?128|Caption go here...}}
  • Rename your images by partition it into logical notation and join them using the “.”
  • Resize large image dynamically to 128px (width)
  • Include caption if possible

Attach Files

  • You can upload files just like how you upload images
  • Zip your file (Yes, standard zip compression and not .tar or .tar.gz and so on) before upload
  • Of course, make sure it is virus clean
  • Again, do not upload patches up

Create Table

^ Heading 1      ^ Heading 2       ^ Heading 3          ^
| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
| Row 2 Col 1    | some colspan (note the double pipe) ||
| Row 3 Col 1    | Row 2 Col 2     | Row 2 Col 3        |
  • All table should have at least one header, if possible
  • All table automatically come with sorttable feature
  • No rowspan support, only colspan
 
wiki/ref.txt · Last modified: 2005/10/27 10:04 by exiang
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki