Personal wikis are new and will be in continual development! If you encounter issues, please report them through the <ahref="http://xowa.org/home/wiki/Xowa.home:Help/Feedback.html"id="xolnki_2"title="Xowa.home:Help/Feedback">Feedback page</a>.
The best place to start is Wikipedia's guide for editing: <ahref="https://en.wikipedia.org/wiki/Help:Getting_started"rel="nofollow"class="external free">https://en.wikipedia.org/wiki/Help:Getting_started</a>
</p>
<p>
The table below is provided for reference. Note the following columns:
</p>
<ul>
<li>
<b>function</b>: the name of the function
</li>
<li>
<b>example</b>: an example of the function as shown in HTML
</li>
<li>
<b>wikitext</b>: the actual wikitext used to render the function
</li>
<li>
<b>html</b>: an alternative way of rendering the same wikitext, but only with html.
<b>HTML tags can be used as an alternative to wikitext.</b>: For example, <i>italicized text</i> can also be shown with <code><i>italicized text</i></code>
</li>
<li>
<b>HTML tags are needed for other functions.</b>: For example, the following have no wikitext equivalent <code><u>underline</u></code>, <code><s>strikethru</s></code>, etc..
</li>
</ul>
<p>
However, there are some notable exceptions:
</p>
<ul>
<li>
<b>anchor tags are not allowed</b>: Any <code><a></code> will be rendered literally. Instead, use an internal / external link. For example, <code>[[Test]]</code>
</li>
<li>
<b>image tags are not allowed</b>: Any <code><img></code> will be rendered literally. Instead, use an internal link in the file namespace. For example, <code>[[File:Image.png]]</code>
</li>
<li>
<b>javascript / events are not allowed</b>: All javascript and "onevent" blocks are removed.
Categories are supported. As a basic example, try the following:
</p>
<ul>
<li>
Edit this page
</li>
<li>
Add the following text: <code>[[Category:Test]]</code>
</li>
<li>
Scroll down to the bottom of the page. You will see a <code>Categories</code> section and <code>Test</code> listed
</li>
<li>
Navigate to <code>Category:Test</code>. You will see the Main page listed
</li>
</ul>
<p>
For more info, see <ahref="https://en.wikipedia.org/wiki/Help:Category"rel="nofollow"class="external free">https://en.wikipedia.org/wiki/Help:Category</a>
</p>
<h3>
<spanclass="mw-headline"id="Images">Images</span>
</h3>
<p>
Images are supported, but the process is slightly complicated due to the set-up of third-party software.
</p>
<p>
Here is a broad overview:
</p>
<ul>
<li>
Set up imagemagick and inkscape on your machine. For more instructions, see <ahref="http://xowa.org/home/wiki/App/Wiki_types/Wikia.com#Part_3c:_Setup_Imagemagick_and_Inkscape"rel="nofollow"class="external free">http://xowa.org/home/wiki/App/Wiki_types/Wikia.com#Part_3c:_Setup_Imagemagick_and_Inkscape</a>
</li>
<li>
Place your images in your wiki directory. Assuming your wiki is set up in <code>C:\your_wiki</code>, then you need to copy an image to <code>C:\your_wiki\file\orig</code>. As an example, do the following:
<ul>
<li>
Download the image from <code>https://upload.wikimedia.org/wikipedia/commons/9/97/The_Earth_seen_from_Apollo_17.jpg</code>
</li>
<li>
Move the image to <code>C:\your_wiki\file\orig\The_Earth_seen_from_Apollo_17.jpg</code>
</li>
<li>
Edit the page, and add the following text: <code>[[File:The_Earth_seen_from_Apollo_17.jpg]]</code>
</li>
</ul>
</li>
<li>
Preview the page. You should see the image.
</li>
</ul>
<p>
For more info, see <ahref="https://en.wikipedia.org/wiki/Wikipedia:Picture_tutorial"rel="nofollow"class="external free">https://en.wikipedia.org/wiki/Wikipedia:Picture_tutorial</a>
</p>
<h3>
<spanclass="mw-headline"id="Table_of_contents">Table of contents</span>
</h3>
<p>
Table of contents (TOC) are automatically generated by XOWA if you have 4 headers (a header being something like <code>== header ==</code>)
</p>
<p>
If you have less than 4 headers, you can force a TOC by adding <code>__TOC__</code>
</p>
<h3>
<spanclass="mw-headline"id="Math">Math</span>
</h3>
<p>
LaT<sub>E</sub>X formatting is available. For example, the following is the formula for the Pythagorean theorem: <spanid='xowa_math_txt_0'>a^2 + b^2 = c^2</span>
Wikipedia-style references are supported. For example, this is a simple reference: <supid="cite_ref-2"class="reference"><ahref="#cite_note-2">[1]</a></sup>.
</p>
<p>
Note that you can hover over the reference number to get a tooltip preview
Other features are supported, including Tabviews, Timelines, Graphs, Hieroglyphics and Musical scores. For examples, see <ahref="http://xowa.org/home/wiki/Xowa.home:Diagnostics.html"id="xolnki_5"title="Xowa.home:Diagnostics">xowa.home:Diagnostics</a>
Most magic words are supported, such as <code>{{CURRENTTIME}}</code> and <code>{{lc:string}}</code>. For more info, see <ahref="https://en.wikipedia.org/wiki/Help:Magic_words"rel="nofollow"class="external free">https://en.wikipedia.org/wiki/Help:Magic_words</a>
Most parser functions are supported, such as <code>{{#expr:2 + 2}}</code>. For more info, see <ahref="https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions"rel="nofollow"class="external free">https://www.mediawiki.org/wiki/Help:Extension:ParserFunctions</a>
Templates are supported, such as <code>{{my_template|arg_1|arg_2|etc...}}</code>. For more info, see <ahref="https://en.wikipedia.org/wiki/Help:A_quick_guide_to_templates"rel="nofollow"class="external free">https://en.wikipedia.org/wiki/Help:A_quick_guide_to_templates</a>
</p>
<p>
Here's a brief example:
</p>
<ul>
<li>
Create a page called <code>Template:Test</code> with the text <code>Hello, from Template:Test -- {{{1|empty}}}</code>
</li>
<li>
Edit any other page (like the <code>Main_Page</code>) and enter <code>{{Test|argument 1}}</code> in the text box.
</li>
<li>
Preview or Save the page. You will see <code>Hello, from Template:Test -- argument 1</code>
Modules are supported, such as <code>{{#invoke:my_module|my_function|arg_1|arg_2|etc...}}</code>. For more info, see <ahref="https://en.wikipedia.org/wiki/Wikipedia:Lua"rel="nofollow"class="external free">https://en.wikipedia.org/wiki/Wikipedia:Lua</a>
</p>
<p>
Here's a brief example:
</p>
<ul>
<li>
Create a page called <code>Module:Test</code> with the following text
</li>
</ul>
<pre>
local p = {}
function p.test( frame )
return "Hello from Module:Test -- " .. frame.args[1];
end
return p
</pre>
<ul>
<li>
Edit any other page (like the <code>Main_Page</code>) and enter <code>{{#invoke:Test|test|argument 1}}</code> in the text box.
</li>
<li>
Preview or Save the page. You will see <code>Hello from Module:Test -- argument 1</code>
<spanclass="mbox-text-span">NOTE: The techniques in this section may change in future versions.</span>
</p>
<p>
<spanclass="mbox-text-span">If you use any of the editing techniques here, please check back occasionally to see if anything has changed.</span>
</p>
</td>
</tr>
</table>
<h3>
<spanclass="mw-headline"id="CSS">CSS</span>
</h3>
<p>
XOWA stores the CSS for each wiki in <code>/xowa/user/anonymous/wiki/your_wiki_name/html</code>. For example, if you're on Windows and your wiki is named <code>test</code>, then the CSS would be at <code>C:\xowa\user\anonymous\wiki\test\html\xowa_common.css</code>
</p>
<p>
Note that the upper-lefthand icon is also stored there as <code>logo.png</code>
</p>
<p>
You can change these files and XOWA will not overwrite them. However, as with any file, please make sure you always keep backups.
XOWA stores the page template in <code>/xowa/bin/any/xowa/cfg/app/xowa.gfs</code>. The actual template is marked in a section called <code>page_read</code>.
</p>
<p>
Please note the following about changing the page:
</p>
<ul>
<li>
The file is replaced on every application update. If you make updates to the file, they will be lost.
<ul>
<li>
If you find that you need to edit this file, please contact me, and I will add a feature to make it configurable in a future release. Really, these instructions are only provided for users who want to experiment.
</li>
</ul>
</li>
<li>
The file uses a custom language specific to XOWA called gfs. Always backup the file when making changes. If you make an invalid change, XOWA will not start
</li>
<li>
The file is only loaded at application start. Any changes will require a restart of the app
XOWA allows custom hooks through Javascript or Lua. For detailed instructions see <ahref="http://xowa.org/home/wiki/Xowa.home:App/Xtn/Scripting.html"id="xolnki_6"title="Xowa.home:App/Xtn/Scripting">xowa.home:App/Xtn/Scripting</a>
For a full list, see <ahref="http://xowa.org/home/wiki/Xowa.home:Special:XowaCfg%3Fgrp%3Dxowa.gui.shortcuts.html"id="xolnki_7"title="Xowa.home:Special:XowaCfg?grp=xowa.gui.shortcuts">xowa.home:Special:XowaCfg?grp=xowa.gui.shortcuts</a>
Wikipedia's guide for editing: <ahref="https://en.wikipedia.org/wiki/Help:Getting_started"rel="nofollow"class="external free">https://en.wikipedia.org/wiki/Help:Getting_started</a>
</li>
<li>
XOWA page on personal wikis: <ahref="http://xowa.org/home/wiki/Xowa.home:App/Personal_wikis.html"id="xolnki_8"title="Xowa.home:App/Personal wikis">xowa.home:App/Personal wikis</a>
</li>
<li>
XOWA help page: <ahref="http://xowa.org/home/wiki/Xowa.home:Help/Contents.html"id="xolnki_9"title="Xowa.home:Help/Contents">Contents page</a>
<li><ahref="http://dumps.wikimedia.org/backup-index.html"title="Get wiki datababase dumps directly from Wikimedia">Wikimedia dumps</a></li>
<li><ahref="https://archive.org/search.php?query=xowa"title="Search archive.org for XOWA files">XOWA @ archive.org</a></li>
<li><ahref="http://en.wikipedia.org"title="Visit Wikipedia (and compare to XOWA!)">English Wikipedia</a></li>
</ul>
</div>
</div>
<divclass="portal"id='xowa-portal-donate'>
<h3>Donate</h3>
<divclass="body">
<ul>
<li><ahref="https://archive.org/donate/index.php"title="Support archive.org!">archive.org</a></li><!-- listed first due to recent fire damages: http://blog.archive.org/2013/11/06/scanning-center-fire-please-help-rebuild/ -->
