[geeklog-cvs] geeklog: Some documentation updates
geeklog-cvs at lists.geeklog.net
geeklog-cvs at lists.geeklog.net
Mon Apr 20 08:13:45 EDT 2009
details: http://project.geeklog.net/cgi-bin/hgweb.cgi/rev/005ae6dbbba0
changeset: 6971:005ae6dbbba0
user: Dirk Haun <dirk at haun-online.de>
date: Sun Apr 19 18:39:22 2009 +0200
description:
Some documentation updates
diffstat:
5 files changed, 49 insertions(+), 44 deletions(-)
public_html/docs/english/changes.html | 1
public_html/docs/english/config.html | 4 +-
public_html/docs/english/index.html | 60 ++++++++++++++++-----------------
public_html/docs/english/install.html | 24 +++++++------
public_html/docs/english/support.html | 4 +-
diffs (207 lines):
diff -r ebf565e1c06f -r 005ae6dbbba0 public_html/docs/english/changes.html
--- a/public_html/docs/english/changes.html Sun Apr 19 16:57:27 2009 +0200
+++ b/public_html/docs/english/changes.html Sun Apr 19 18:39:22 2009 +0200
@@ -34,6 +34,7 @@
<ul>
<li>The minimum PHP version required by Geeklog is now <strong>PHP 4.3.0</strong>. Given that the PHP team ended support for PHP 4 in August 2008, you should be
looking into upgrading to PHP 5 anyway.</li>
+<li>Includes <a href="http://www.fckeditor.net/">FCKeditor</a> 2.6.4</li>
</ul>
diff -r ebf565e1c06f -r 005ae6dbbba0 public_html/docs/english/config.html
--- a/public_html/docs/english/config.html Sun Apr 19 16:57:27 2009 +0200
+++ b/public_html/docs/english/config.html Sun Apr 19 18:39:22 2009 +0200
@@ -895,8 +895,8 @@
<tr>
<td valign="top"><a name="desc_wikitext_editor">wikitext_editor</a></td>
<td valign="top">false</td>
- <td valign="top">Allow using wiki syntax in stories. This adds a third
- option, "Wiki-style format", to the Post Mode dropdown in the story editor
+ <td valign="top">Allow using <a href="http://pear.reversefold.com/dokuwiki/text_wiki:samplepage">wiki syntax</a> in stories. This adds a third option,
+ "Wiki-style format", to the Post Mode dropdown in the story editor
(implemented using the <a href="http://pear.php.net/package/Text_Wiki">PEAR::Text_Wiki</a> package).</td></tr>
</table>
diff -r ebf565e1c06f -r 005ae6dbbba0 public_html/docs/english/index.html
--- a/public_html/docs/english/index.html Sun Apr 19 16:57:27 2009 +0200
+++ b/public_html/docs/english/index.html Sun Apr 19 18:39:22 2009 +0200
@@ -60,52 +60,52 @@
<h3>Blog/CMS Features</h3>
<ul>
-<li>Create, Schedule, Post and Edit articles in multiple topics
-<li>Save story drafts until they are ready for publishing.
-<li>Control over formatting used in articles (HTML whitelists)
-<li>Control over acceptable content (filtering of offensive language)
-<li>Embed images or other content in articles
-<li>Multiple Authors can post
-<li>Submissions from users
-<li>Support for comments, trackbacks and pingbacks
-<li>Export and import in all common syndication formats (RSS/RDF/Atom etc)
-<li>Spam detection and rejection
-<li>Robust calendar feature with support for personalized calendars.
-<li>Support for OpenID and other remote authentication methods.
-<li>Extendible via numerous Open Source plugins.
+<li>Create, Schedule, Post and Edit articles in multiple topics</li>
+<li>Save story drafts until they are ready for publishing.</li>
+<li>Control over formatting used in articles (HTML whitelists)</li>
+<li>Control over acceptable content (filtering of offensive language)</li>
+<li>Embed images or other content in articles</li>
+<li>Multiple Authors can post</li>
+<li>Submissions from users</li>
+<li>Support for comments, trackbacks and pingbacks</li>
+<li>Export and import in all common syndication formats (RSS/RDF/Atom etc)</li>
+<li>Spam detection and rejection</li>
+<li>Robust calendar feature with support for personalized calendars.</li>
+<li>Support for OpenID and other remote authentication methods.</li>
+<li>Extendible via numerous Open Source plugins.</li>
</ul>
<h3>Administration Features</h3>
<ul>
-<li>Easy to install with a new automated installer in 1.5
-<li>Fully support for internationalization and localization
-<li>Easy to use admin interface
-<li>Admin interface has complete configurability for all Geeklog Functions.
-<li>User-specified theming engine for custom look and feel.
+<li>Easy to install with an automated installer</li>
+<li>Fully support for internationalization and localization</li>
+<li>Easy to use admin interface</li>
+<li>Admin interface has complete configurability for all Geeklog functions.</li>
+<li>User-specified theming engine for custom look and feel.</li>
</ul>
<h3>Security Features</h3>
<ul>
-<li>User accounts and access controls.
+<li>User accounts and access controls.</li>
<li>Robust *nix-like security model for all objects which can be extended for
- use in plugins
-<li>Access can be defined for each article, topic etc
-<li>All passwords are stored encrypted.
-<li>All admin access is logged.
-<li>All errors are logged.
-<li>Complete error logging on all forms and SQL calls.
+ use in plugins</li>
+<li>Access can be defined for each article, topic etc</li>
+<li>All passwords are stored encrypted.</li>
+<li>All admin access is logged.</li>
+<li>All errors are logged.</li>
+<li>Complete error logging on all forms and SQL calls.</li>
</ul>
<h3>Developer Features</h3>
<ul>
-<li>Plugin support with API for developers.
-<li>A fully configurable block system, with php-in-block support.
-<li>Well organized codebase, use of PHP's Object-Oriented features.
-<li>Thin database abstraction layer allowing Geeklog to be ported to DBMS's
- other than the defaults (MySQL and MSSQL supported directly).
+<li>Plugin support with API for developers.</li>
+<li>A fully configurable block system, with php-in-block support.</li>
+<li>Well organized codebase, use of PHP's Object-Oriented features.</li>
+<li>Thin database abstraction layer allowing Geeklog to be ported to DBMS's</li>
+ other than the defaults (MySQL and MSSQL supported directly).</li>
</ul>
<h2><a name="introduction">Introduction</a></h2>
diff -r ebf565e1c06f -r 005ae6dbbba0 public_html/docs/english/install.html
--- a/public_html/docs/english/install.html Sun Apr 19 16:57:27 2009 +0200
+++ b/public_html/docs/english/install.html Sun Apr 19 18:39:22 2009 +0200
@@ -28,7 +28,8 @@
<ul>
<li>Directory: Same as a folder.</li>
- <li>Path: A physical location on a server that describes where files and directories are. On Windows paths begin with the drive letter (<code>c:/inetpub/wwwroot/</code>), on *nix paths start at root (<code>/</code>) like (<code>/var/www/</code>) </li>
+ <li>Path: A physical location on a server that describes where files and directories are. On Windows paths begin with the drive letter (<code>c:/inetpub/wwwroot/</code>), on *nix paths start at root (<code>/</code>) like (<code>/var/www/</code>)</li>
+ <li><a name="public_html">public_html</a>: Common name for the directory on a webserver that contains all files that are accessible via a URL (other common names: htdocs, www)</li>
<li>URL: Uniform Resource Locator, the address of a specific piece of information on the web (<code>http://www.foo.com/</code>)</li>
</ul>
@@ -37,7 +38,7 @@
<h3><a name="preinstall">Required Software</a></h3>
- <p>To install and use Geeklog you will need to have a server running Apache or Microsoft IIS with PHP 4.1.0 or higher installed. You will also need either <a href="http://dev.mysql.com/downloads/">MySQL 3.23.2</a> or greater or <a href="http://www.microsoft.com/sql/default.mspx">Microsoft SQL Server 2000</a> or newer.</p>
+ <p>To install and use Geeklog you will need to have a server running Apache or Microsoft IIS with PHP 4.3.0 or higher installed. You will also need either <a href="http://dev.mysql.com/downloads/">MySQL 3.23.2</a> or greater or <a href="http://www.microsoft.com/sql/default.mspx">Microsoft SQL Server 2000</a> or newer.</p>
<h3><a name="things_you_should_know">Things You Should Know</a></h3>
@@ -58,7 +59,7 @@
</li>
<li>
<p>Unpack the downloaded tarball file by running: </p>
- <p><code>tar -zxvf geeklog-1.5.1.tar.gz</code> </p>
+ <p><code>tar -zxvf geeklog-1.6.0.tar.gz</code> </p>
<p><strong>Note:</strong> Some users have reported that WinZip corrupts certain Geeklog files during decompression. This will cause errors during the installation process. You are strongly urged not to use WinZip. Try <a href="http://www.7-zip.org/">7-Zip</a> or <a href="http://www.rarlab.com/">WinRAR</a> if you must decompress the file locally.</p>
</li>
@@ -66,9 +67,9 @@
<p>Create a blank MySQL or Microsoft SQL database and a user account with privileges to modify it. Your hosting provider may have already set up a database and account for you, contact them if you need assistance with this step.</p>
</li>
<li>
- <p>Place the contents of <code>geeklog-1.5.1/public_html/</code> into your web root directory on your web server. The web root directory is often named "public_html", "htdocs", or "www".</p>
+ <p>Place the contents of <code>geeklog-1.6.0/public_html/</code> into your web root directory on your web server. The web root directory is often named "public_html", "htdocs", or "www".</p>
- <p>Next, place the remaining contents of <code>geeklog-1.5.1/</code> into either the parent directory of your root web directory (recommended) or any other non public folder and the installation wizard will attempt to locate them automatically. If it cannot you will be asked to specify their paths during installation. This is done as a security measure to prevent access to Geeklog system files by Internet users. </p>
+ <p>Next, place the remaining contents of <code>geeklog-1.6.0/</code> into either the parent directory of your root web directory (recommended) or any other non public folder and the installation wizard will attempt to locate them automatically. If it cannot you will be asked to specify their paths during installation. This is done as a security measure to prevent access to Geeklog system files by Internet users. </p>
<p><strong>Note:</strong> If your hosting provider does not allow you to place files outside of your root web directory:</p>
<ul>
@@ -106,12 +107,12 @@
</li>
<li>
<p>Unpack the downloaded tarball file by running: </p>
- <p><code>tar -zxvf geeklog-1.5.1.tar.gz</code> </p>
+ <p><code>tar -zxvf geeklog-1.6.0.tar.gz</code> </p>
<p><strong>Note:</strong> Some users have reported that WinZip corrupts certain Geeklog files during decompression. This will cause errors during the installation process. You are strongly urged not to use WinZip. Try <a href="http://www.7-zip.org/">7-Zip</a> or <a href="http://www.rarlab.com/">WinRAR</a> if you must decompress the file locally.</p>
</li>
<li>
- <p>Place the contents of <code>geeklog-1.5.1/</code> into the same directory your old installation was located. For instance, if your old Geeklog was in <code>/usr/home/www/geeklog/</code>, then your new installation should also be in <code>/usr/home/www/geeklog/</code>.</p>
+ <p>Place the contents of <code>geeklog-1.6.0/</code> into the same directory your old installation was located. For instance, if your old Geeklog was in <code>/usr/home/www/geeklog/</code>, then your new installation should also be in <code>/usr/home/www/geeklog/</code>.</p>
</li>
<li>Depending on the version you're upgrading from:
<ul>
@@ -213,16 +214,19 @@
<p>If you still have problems, please do one or more of the following:</p>
<ol>
<li>
- <p>Go to <a href="http://www.geeklog.net">http://www.geeklog.net</a> and check out the Support section. The Support section includes a <a href="http://www.geeklog.net/faqman/">FAQ</a> and a <a href="http://www.geeklog.net/search.php">search system</a> (try searching for the error message, if you get one).</p>
+ <p>Go to <a href="http://www.geeklog.net">http://www.geeklog.net</a> and check out the Support section. The Support section includes a <a href="http://www.geeklog.net/faqman/" title="Frequently Asked Questions">FAQ</a>, <a href="http://www.geeklog.net/forum/">forums</a>, and a <a href="http://www.geeklog.net/search.php">search system</a> (try searching for the error message, if you get one).</p>
</li>
<li>
- <p>Visit the mailing list archives at <a href="http://lists.geeklog.net/pipermail/geeklog-users/">http://lists.geeklog.net/pipermail/geeklog-users/</a>. You can also <a href="http://lists.geeklog.net/listinfo/geeklog-users">subscribe to the mailing list</a> and post your question to the Geeklog community.</p>
+ <p>Visit the mailing list archives at <a href="http://eight.pairlist.net/pipermail/geeklog-users/">http://lists.geeklog.net/pipermail/geeklog-users/</a>. You can also <a href="http://lists.geeklog.net/mailman/listinfo/geeklog-users">subscribe to the mailing list</a> and post your question to the Geeklog community.</p>
</li>
<li>
- <p>Try the chat room at <code>irc.freenode.net, channel #geeklog</code>. Please have all your path information in siteconfig.php and lib-common.php readily available.</p>
+ <p>Try the chat room at <code>irc.freenode.net, channel #geeklog</code>. Please have all your path and database information in siteconfig.php and db-config.php readily available.</p>
</li>
<li>
<p>Try entering the text of the error message on Google. Chances are you will find someone else who had the same problem and fixed it. And sometimes searching for a specific error will cause Google to bring up broken pages that have the same error.</p>
+ </li>
+ <li>
+ <p>Even <a href="support.html">more support options</a> are listed elswhere in this documentation.</p>
</li>
</ol>
diff -r ebf565e1c06f -r 005ae6dbbba0 public_html/docs/english/support.html
--- a/public_html/docs/english/support.html Sun Apr 19 16:57:27 2009 +0200
+++ b/public_html/docs/english/support.html Sun Apr 19 18:39:22 2009 +0200
@@ -53,9 +53,9 @@
<h3>Development</h3>
-<p>Want to develop a plugin or some other add-on? Read the <a href="http://gplugs.sourceforge.net/pluginman/">Plugins Developer's Guide</a> and join the <a href="http://lists.geeklog.net/mailman/listinfo/geeklog-modules">geeklog-modules</a> and <a href="http://lists.geeklog.net/mailman/listinfo/geeklog-devel">geeklog-devel</a> mailing lists.</p>
+<p>Want to develop a plugin or some other add-on? Read the <a href="http://wiki.geeklog.net/index.php/Plugin_Developers_Handbook">Plugins Developer's Guide</a> and join the <a href="http://lists.geeklog.net/mailman/listinfo/geeklog-modules">geeklog-modules</a> and <a href="http://lists.geeklog.net/mailman/listinfo/geeklog-devel">geeklog-devel</a> mailing lists.</p>
-<p>Want to help in Geeklog development? See <a href="http://www.geeklog.net/article.php/20030803155454822">this story</a> for suggestions on how to get started. And if you already made a modification, why not <a href="http://project.geeklog.net/">submit a patch</a>?
+<p>Want to help in Geeklog development? See <a href="http://www.geeklog.net/article.php/developer-resources">this story</a> for suggestions on how to get started. And if you already made a modification, why not <a href="http://wiki.geeklog.net/index.php/Submitting_Patches">submit a patch</a>?
<h2>Security Issues</h2>
More information about the geeklog-cvs
mailing list