|
From: Garvin H. <gar...@us...> - 2004-08-26 11:33:38
|
Update of /cvsroot/php-blog/serendipity In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv12466 Modified Files: README Log Message: document changes from pixel/ Index: README =================================================================== RCS file: /cvsroot/php-blog/serendipity/README,v retrieving revision 1.9 retrieving revision 1.10 diff -u -d -r1.9 -r1.10 --- README 8 May 2004 23:38:16 -0000 1.9 +++ README 26 Aug 2004 11:33:29 -0000 1.10 @@ -2,7 +2,8 @@ # README # ######################################################################## -(Temporary document until a final documentation draft is finished!) +For the most up-to-date information on documentation, creating styles, +plugins and so on, please visit our Wiki on http://www.s9y.org/! ######################################################################## # UPDATING # @@ -13,7 +14,7 @@ from 0.5. The upgrader will perform its automatic actions, as soon as you have copied the new s9y files over your old installation and access the start page of your blog. -You can speed up the process of backing up your data and copying the files by +You can speed up the process of backing up your data and copying the files by using the supplied "upgrade.sh" script. Be sure to edit the file and change the variables to your needs. @@ -78,7 +79,7 @@ subheader). If you have a custom template, you need to adapt to those changes. To make them look like your header previously has, insert this in your style.css: - + a.homelink1, a.homelink1:hover, a.homelink1:link, @@ -133,7 +134,7 @@ templates, your menu structure and such. Now you want this file to be used to include your weblog. A simple content.php could look like this: - + <?php $homepage = new Template_Class; $homepage->set_template($_REQUEST['page']); @@ -142,15 +143,15 @@ $homepage->output_footer(); $homepage->track_statistics(); ?> - + So normally your file would be called with 'content.php?page=about' to display your 'about' page of your personal homepage. - + Now we want this file to be displayed, having the 'page' variable being set to 'blog'. - + For this, we set up a 'wrapper.php' file: - + <?php $_REQUEST['page'] = 'blog'; // Let serendipity generate our content: @@ -158,34 +159,34 @@ require 'index.php'; $blog_data = ob_get_contents(); ob_end_clean(); - + // Now we include our normal content building file. // This one has to make use of your $blog_data variable to print // the content where appropriate! require 'content.php'; ?> - + You would then set your 'indexFile' serendipity-option to the 'wrapper.php' file. - + 2. Plugin panes & HTML-headers - + With the example above, we only get the main blog data printed. One of the most visible actions when using the 'embed' option is that the plugin panes are not generated. And HTML headers/foooters are also not provided by s9y in this case, as this should be done by your 'content.php' file. - + So you have to include them in your 'content.php' file, to have them visible in your embedded setup. - + You can use this snippet: - <?php + <?php serendipity_plugin_api::generate_plugins('left','div'); serendipity_plugin_api::generate_plugins('right','div'); ?> somewhere in your 'content.php' file. - + The 'embed' option is therefore only recommended to be used by advanced users going for a most flexible setup! @@ -253,17 +254,15 @@ VirtualHosts. But the directory name 's9y' is significant. Now copy the subdirectories called - + * "/usr/local/lib/php/s9y/deployment/" [core redirection files] * "/usr/local/lib/php/s9y/templates/" [templates so that users can change them] - * "/usr/local/lib/php/s9y/pixel/" [core image files] * "/usr/local/lib/php/s9y/htmlarea/" [htmlarea WYSIWYG-editor] to each of the user's subdirectories: $ cp -r /usr/local/lib/php/s9y/deployment/* /home/www/garvin.s9yblogs.org/htdocs/ $ cp -r /usr/local/lib/php/s9y/templates /home/www/garvin.s9yblogs.org/htdocs/ -$ cp -r /usr/local/lib/php/s9y/pixel /home/www/garvin.s9yblogs.org/htdocs/ $ cp -r /usr/local/lib/php/s9y/htmlarea /home/www/garvin.s9yblogs.org/htdocs/ $ chown -R garvin.www /home/www/garvin.s9yblogs.org/htdocs/* $ chmod go+rwx /home/www/garvin.s9yblogs.org/htdocs @@ -271,7 +270,6 @@ $ cp -r /usr/local/lib/php/s9y/deployment/* /home/www/j.s9yblogs.org/htdocs/ $ cp -r /usr/local/lib/php/s9y/templates /home/www/j.s9yblogs.org/htdocs/ -$ cp -r /usr/local/lib/php/s9y/pixel /home/www/j.s9yblogs.org/htdocs/ $ cp -r /usr/local/lib/php/s9y/htmlarea /home/www/j.s9yblogs.org/htdocs/ $ chown -R j.www /home/www/j.s9yblogs.org/htdocs/* $ chmod go+rwx /home/www/j.s9yblogs.org/htdocs @@ -279,7 +277,6 @@ $ cp -r /usr/local/lib/php/s9y/deployment/* /home/www/tom.s9yblogs.org/htdocs/ $ cp -r /usr/local/lib/php/s9y/templates /home/www/tom.s9yblogs.org/htdocs/ -$ cp -r /usr/local/lib/php/s9y/pixel /home/www/tom.s9yblogs.org/htdocs/ $ cp -r /usr/local/lib/php/s9y/htmlarea /home/www/tom.s9yblogs.org/htdocs/ $ chown -R tom.www /home/www/tom.s9yblogs.org/htdocs/* $ chmod go+rwx /home/www/tom.s9yblogs.org/htdocs @@ -292,7 +289,7 @@ sql> CREATE TABLE my_managed_s9y_blogs (url varchar(255) default null); sql> INSERT INTO my_managed_s9y_blogs (url) VALUES ('http://garvin.s9yblogs.org/'); sql> INSERT INTO my_managed_s9y_blogs (url) VALUES ('http://j.s9yblogs.org/'); -sql> INSERT INTO my_managed_s9y_blogs (url) VALUES ('http://tom.s9yblogs.org/'); +sql> INSERT INTO my_managed_s9y_blogs (url) VALUES ('http://tom.s9yblogs.org/'); Now you are almost ready for take-off. We assume that every user has access to a seperate SQL database where his blog-data is later stored @@ -314,11 +311,11 @@ * If you update the core library files from version 0.5 to 0.6 (for example) every user of your core library will get the default s9y- Upgrader script to see and needs to update his local configuration. - + As a provider for s9y blogs to your users, you are advised to migrate the user's blogs on your own. To do so, it is best that you always have a "spare" testing blog installed just like your user's blogs. - + Open that installation and look at the upgrader. Execute it and see that it completes without errors. If that happened, you should cycle through a list of ALL your s9y-managed blogs like this: @@ -329,7 +326,7 @@ $fp = fopen($row['url'] . 'serendipity_admin.php?serendipity[action]=upgrade'); } ?> - + So basically all you need to do is call that script for every s9y- powered blog you host. |
