--- tmp/help.orig 2008-12-13 06:43:29.000000000 +0100 +++ tmp/help 2008-12-13 06:43:29.000000000 +0100 @@ -0,0 +1,95 @@ +///Table of Contents Goes Here/// + +# Introduction + +The r00t project is a basic or inspired project of the [PYGUICMS] +(http://dvm.zapto.org:8080/pyguicms/). See the [project r00t] (project_r00t) +page for the project informations and for some screenshots. + +# Difference between r00t and PYGUICMS + +There are much things different. As first, the `r00t` is a basic version of the +`PYGUICMS`. The `r00t` will be simple and mostly point to some other +"specialized" stuff. The `r00t` has some little variations like: + + * Store images in the database, while the `PYGUICMS` (planned to) store the + images on the files system. + * `r00t` has an autocompletion search field based on the keywords fields of + the pages table. This feature still needs to be improved and will be ported to + the `PYGUICMS`. + +# Which markup language can i use? + +You can use plain text, HTML and [python-markdown] +(http://www.freewisdom.org/projects/python-markdown/), when writing some page, +news, comments on this website. See the [sandbox] (sandbox) page for the +python-markup language. + +You just need to make sure that you write compliant HTML code, otherwise you +may get some errors when trying to save an item. + +# Diff system + +The pages section got a diff system. Each time a page is update, a diff is +create of this. So that we easy can see which parts of the page has changed. +The advantage of this is that we can easy rollback to previous version of the +document. + +# Users and groups management + +In the admin interface we can easy manage users and groups. With a few clicks +we can add/modify a user and grant access. + +# Antispam and captcha system + +As some people lost they way in this crazy world, we had need to build an +anti-spam system to prevent some virtual noise. There are two anti-spam system +build. The first that check for some predefined words and the second a +`captcha` field that you may fill in. + +We can easily improve the banned words with adjusting/adding some new words +that will be banned. Most of the time words should be banned but we add some +website names as most of the time, spam are links to some other websites. + +# Sub Links + +The `sublinks` are these links you see on the top and bottom of each page. +These links can be adjusted to fits your needs. + +# Pages, news, blogs comments + +Each of these items can get comments. As this may seems so logic, everyone can +leave some comments. + +# Image files + +This system permits to add some images to the database so that this can be +easily used in pages, news items etc. This system is very interesting if you +host the `r00t` project on a webserver you can't control at 100%. If you can't +upload images to some desired directory, you can store these images in the +database. + +Note that there are some important points to keep in mind: + + * The size of a file you may able to upload to the database is limited to +- + 613KB when using `SQLite`. *Need to check the exact size.* This is a + restriction set by `SQLite` for the BLOB column. The size can be increased or + decreased but `SQLite` needs to be recompiled. Read more [here] + (http://www.sqlite.org/limits.html). + + * When making use of `MySQL` the limited size increase but there's still a + limit. *Need to check the exact size.* + +Anyway, it's a bad deal to store big files into a database! Instead, store this +on the file system. + +# Todos + +The todo system is build for the admin of the `r00t` project. This is a little +system to share some things that needs to be done. + +# Find more help + +You can get some more informations in the documentation of the `PYGUICMS`. Like +the installation, deployment etc... See the [pyguicms-trac] +(https://dvm.zapto.org:8080/pyguicms-trac/). \ No newline at end of file