simsi moblog - your mobile photo weblog |
[Go to Google|http://www.google.com]
(0.99)roWiki sports all important formatting rules to use in your pages. As in every wiki, new pages are created simply by linking to them. And as the owner of a roWiki, you can lock pages (e.g. the Home-page) to prevent further changes once you consider them finished. There is a search-function, to quickly locate content in the wiki. The "Recent changes"-button always keeps you informed about anything new. And a revision history lets you restore older versions of pages, in case something terrible happens...
I designed roWiki with ease of use and especially installation in mind. It consists of only a single PHP-script of a 150 lines (including comments) you need to put on your web-server. The pages are stored as plaintext-files, so no databases or any other requirements. And using the "template.html", you can change the looks of your wiki any way you see fit.
tar -xzvf rowiki_1_02.tgz
or double-click) you will have a folder with two files and two directories: "index.php" is the script itself, while "template.html" determines the look of your wiki. The "pages/" folder will store your wiki pages, and contains "Home.txt" and "Help.txt" - two pages there to help getting you started. "history/" will store the revision history of your Wiki. You can retrieve old versions of pages from here, in case anything goes wrong.If you can't edit the pages, please refer to troubleshooting to change the permissions on your web-server!
To customize your wiki you should ...
$WIKI_TITLE
is the name of your wiki. In the default template, this is displayed in the top left corner of every page.
$START_PAGE
determines which page will be shown upon entering the wiki. As you see, this defaults to "Home".
$HOME_BUTTON
, $HELP_BUTTON
, $EDIT_BUTTON
, $DONE_BUTTON
, $PROTECTED_BUTTON
, $SEARCH_BUTTON
, $SEARCH_RESULTS
, $NEW_PAGE
and $RECENT_CHANGES
are the captions for the buttons used to interact with the wiki. You can change them to show whatever you like, e.g. another language. Wenn Sie also Ihr roWiki lieber in Deutsch betreiben möchten ... (^_^)
$TIME_FORMAT
determines how dates (e.g. last changes to pages) are displayed. The string follows the conventions for the strftime()-function.
$PAGES_DIR
lets you choose where roWiki stores its pages. By default, they are put in the subdirectory "pages/" (mind the trailing slash).
$BACKUP_DIR
specifies a directory where a revision history of every page of your wiki is kept (including a timestamp and the IP of the user who made the change). If for some reason you need to restore an older version of a page, you can find it here. If you decide not to store backups, just leave this variable empty.
monospace font
, and the layout is preserved (perfect for code-examples)
http://www.rowlff.de/rowlff.png
, roWiki automagically displays that image.
<html>
Last Change: {TIME}
...
Home
!!Welcome
I always thought installing a '''wiki''' would be ...
*difficult
*time-consuming
*not worth it
----
When all I had to do was download it from http://www.rowlff.de/rowiki/ ... and tweak the template:
{<html>
Last Change: {TIME}
...}
[Home]
Although it's a classic, I decided against employing the WikiWordSyntax (aka CamelCase) for internal links - these days, too many words use capitalization. Using [Square Brackets] instead gives you the freedom to choose whatever linktext you want.
roWiki honors the permissions of files on the web-server. So, to lock a page from further changes, simply log into your server and remove the write-permissions of the file. Remember, the filename consists of the pagename plus the extension ".txt".
Example: To lock the page "Home", enter chmod a-w Home.txt
.
After familiarizing yourself with roWiki, you can delete "Home.txt" and "Help.txt" (and any other files you might have created, like "Sandbox.txt") from your "pages/" directory and start a fresh wiki.
A: If you just copied "Home.txt" to your web-server, the file most probably has the wrong permissions. FTP into your server and change them using chmod a+w Home.txt
, so the file can be edited and written!
Q: The default Home-page you mentioned doesn't show up?
A: You did put it on the server, right? And make sure the directory you set in $PAGES_DIR
exists, is set correctly (no leading, but a trailing slash, e.g. "pages/") and contains the .txt-files!
Q: When I press "Done" after editing a page, the error-message "Could not write page!" or "Could not write backup of page!" appears?
A: For your wiki to be able to write new or edited files, the directory the pages are stored (set in $PAGES_DIR
and probably $BACKUP_DIR
) must be writable. FTP into the server and use chmod a+w directory
to set the permissions!
Q: After installing the wiki, I only get the error-message "'template.html' is missing!"?
A: You probably forgot to put "template.html" on the server. roWiki needs this to determine its layout!
Copyright 2003, 2004, Marc Rohlfing
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.