X-Git-Url: https://dev.renevier.net/gitweb.cgi?p=syp.git;a=blobdiff_plain;f=README.txt;h=838116204485a4a268028e698bd736a2995e9d21;hp=33f29a31362a9c3b15f28a875e0c7e21f378f415;hb=bc8447229929345cdb3cb3af88e309f0626fe9bb;hpb=b6cae6a5698c5d0655d921f78f0ccab470bf034c diff --git a/README.txt b/README.txt index 33f29a3..8381162 100644 --- a/README.txt +++ b/README.txt @@ -17,42 +17,68 @@ Installation * manual configuration -- edit inc/settings.php.in and copy it to inc/settings.php -- upload syp to your webserver -- open http://yoururl.com/install.php with your web browser to finalize + - edit `inc/settings.php.in` and copy it to `inc/settings.php` + - upload syp to your webserver + - open http://yoururl.com/install.php with your web browser to finalize installation (database tables creation). * automatic configuration -- upload syp to your webserver -- open http://yoururl.com/install.php with your web browser and follow + - upload syp to your webserver + - open http://yoururl.com/install.php with your web browser and follow instructions. -For automatic configuration to work, inc/ directory needs to be writeable. Use -chmod to set the appropriate directory permissions. If in doubt, chmod to 0777. -Alternatively, you can use manual method. +For automatic configuration to work, `inc/` directory needs to be writeable. Use +`chmod` to set the appropriate directory permissions. If in doubt, `chmod` to +`0777`. Alternatively, you can use manual method. Some advanced configuration options are not available with automatic method. If you need to set those options, use manual configuration. Upgrade ------------ -- make a copy of inc/settings.php -- make a copy of upload/ (or directory where your photos and thumbnails are stored). -- delete old version of syp from your server -- upload new version -- edit inc/settings.php again (copy old version of file may not be enough - because new settings may have appeared) -- copy upload/ back. +- uncompress new version of syp +- upload uncompressed version to your server - open http://yoururl.com/upgrade.php with your web browser +co-administrators +----------------- +It is possible to allow other people to upload and manage +pictures/descriptions. In admin interface, select "Add an co-administrator" +and fill informations (user name and password). Then, you need to communicate +to your user its username and password. He/She will be able to modify this +password afterward. Only admin can add new users. + +Other co-administrators will be able to add markers, and delete/modifiy them. +They cannot modify markers they have not created. admin is the only user +allowed to manage markers of other users. If you plan to have several +co-administrators, you may want to create a normal user for yourself, and use +it to manage your markers. You will then only use admin account when really +needed. + +Currently, SYP does not allow + +Custom CSS +---------- +You can define your own css rules by creating custom css files: +- `media/syp_custom.css` for user interface +- `media/admin_custom.css` for admin interface +Those files are sourced after all other css files. So, rules defined in those +custom files will override other rules. + server API ---------- -The way server side communicates with client side is described at -http://dev.renevier.net/syp.git/?a=blob_plain;f=devdoc/api.txt -That document is mainly aimed at developers and inquiring people. You should -not need it if you just want to install syp on your website. +Client/server communication follows an API. This allow for example creation of +scripts to automate some tasks. [API description] [1] is mainly aimed at +developers and inquiring people. You should not need it if you just want to +install syp on your website. + +[1]: http://dev.renevier.net/syp.git/?a=blob_plain;f=devdoc/api.txt Author ------ Arno Renevier + +Contributor(s): +--------------- + Sebastian Klemm (german translation)