[geeklog-cvs] geeklog: Updated documentation, mostly to document the autotags ...
geeklog-cvs at lists.geeklog.net
geeklog-cvs at lists.geeklog.net
Sat Nov 7 13:37:41 EST 2009
changeset 7451:42760e758229
url: http://project.geeklog.net/cgi-bin/hgwebdir.cgi/geeklog/rev/42760e758229
user: Dirk Haun <dirk at haun-online.de>
date: Sat Nov 07 18:22:52 2009 +0100
description:
Updated documentation, mostly to document the autotags provided by the plugins
diffstat:
public_html/docs/english/calendar.html | 16 ++++++++++++++++
public_html/docs/english/index.html | 6 ++++--
public_html/docs/english/links.html | 21 +++++++++++++++++++++
public_html/docs/english/polls.html | 18 ++++++++++++++++++
public_html/docs/english/staticpages.html | 22 +++++++++++++++++++---
5 files changed, 78 insertions(+), 5 deletions(-)
diffs (157 lines):
diff -r 6e857a94c80e -r 42760e758229 public_html/docs/english/calendar.html
--- a/public_html/docs/english/calendar.html Sat Nov 07 15:55:10 2009 +0100
+++ b/public_html/docs/english/calendar.html Sat Nov 07 18:22:52 2009 +0100
@@ -122,6 +122,22 @@
</ul>
+<h2><a name="autotags">Autotags</a></h2>
+
+<p>The Calendar Plugin provides one <a href="http://www.geeklog.net/article.php/autolinks" title="geeklog.net: About Autolinks and Autotags">autotag</a>,
+<code>[event:]</code>. You can use this autotag to link to an event in the
+calendar without having to type out the URL. Simply add the event's ID after
+the colon. It will then create a link to that event and use the event's title
+as the link text. Alternatively, you can add your own link text after the ID
+(but before the closing bracket).</p>
+
+<p>For example, on geeklog.net:</p>
+<ul>
+<li><code>[event:20090805065311513]</code> will be translated to: <code><a href="http://www.geeklog.net/calendar/event.php?eid=20090805065311513">FrOSCon - Free and Open Source Software Conference</a></code></li>
+<li><code>[event:20090805065311513 FrOSCon 2009]</code> will be translated to: <code><a href="http://www.geeklog.net/calendar/event.php?eid=20090805065311513">FrOSCon 2009</a></code></li>
+</ul>
+
+
<div class="footer">
<a href="http://wiki.geeklog.net/">The Geeklog Documentation Project</a><br>
All trademarks and copyrights on this page are owned by their respective owners. Geeklog is copyleft.
diff -r 6e857a94c80e -r 42760e758229 public_html/docs/english/index.html
--- a/public_html/docs/english/index.html Sat Nov 07 15:55:10 2009 +0100
+++ b/public_html/docs/english/index.html Sat Nov 07 18:22:52 2009 +0100
@@ -16,8 +16,8 @@
you will find it very easy to use, and very powerful.
<p>These documents have been created to make Geeklog even easier for you!
-Apart from the usual stuff like how to install Geeklog, we also have
-provided the full Developer API documentation, so you can develop your own
+Apart from the usual stuff like how to install Geeklog, we also provide links
+to the full Developer API documentation, so you can develop your own
themes and plugins and make it even better.
<ul>
@@ -51,6 +51,8 @@
<li><a href="changes.html">List of Changes</a></li>
</ul>
+<p>Further information about using Geeklog can be found in our ever-expanding <a href="http://wiki.geeklog.net/">Geeklog Documentation Wiki</a>, maintained by the Geeklog community.</p>
+
<h2><a name="features">Features of Geeklog</a></h2>
<p>Geeklog is a PHP/MySQL based application for managing dynamic web content.
diff -r 6e857a94c80e -r 42760e758229 public_html/docs/english/links.html
--- a/public_html/docs/english/links.html Sat Nov 07 15:55:10 2009 +0100
+++ b/public_html/docs/english/links.html Sat Nov 07 18:22:52 2009 +0100
@@ -158,6 +158,27 @@
directory - but that is not used any more and can be safely removed.</p>
+<h2><a name="autotags">Autotags</a></h2>
+
+<p>The Links Plugin provides one <a href="http://www.geeklog.net/article.php/autolinks" title="geeklog.net: About Autolinks and Autotags">autotag</a>,
+<code>[link:]</code>. You can use this autotag to embed one of the links from
+your site's Links section into an article or a comment (amongst other things)
+without having to type out the full URL. Simply add the link's ID after the
+colon. It will then create a link to the site in question and use the link's
+title as the link text. Alternatively, you can add your own link text after the
+ID (but before the closing bracket).</p>
+
+<p>For example, on geeklog.net:</p>
+<ul>
+<li><code>[link:20030921074903113]</code> will be translated to: <code><a href="http://www.geeklog.net/links/portal.php/link/20030921074903113">Groklaw</a></code></li>
+<li><code>[event:20030921074903113 read everything about the SCO case]</code> will be translated to: <code><a href="http://www.geeklog.net/links/portal.php/link/20030921074903113">read everything about the SCO case</a></code></li>
+</ul>
+
+<p>Note that the <code>[link:]</code> autotag will always create links that go
+through Geeklog's <tt>portal.php</tt> script so that the number of clicks on
+that link can be counted.</p>
+
+
<div class="footer">
<a href="http://wiki.geeklog.net/">The Geeklog Documentation Project</a><br>
All trademarks and copyrights on this page are owned by their respective owners. Geeklog is copyleft.
diff -r 6e857a94c80e -r 42760e758229 public_html/docs/english/polls.html
--- a/public_html/docs/english/polls.html Sat Nov 07 15:55:10 2009 +0100
+++ b/public_html/docs/english/polls.html Sat Nov 07 18:22:52 2009 +0100
@@ -129,6 +129,24 @@
you shouldn't take the results too seriously.</p>
+<h2><a name="autotags">Autotags</a></h2>
+
+<p>The Polls Plugin provides 3 <a href="http://www.geeklog.net/article.php/autolinks" title="geeklog.net: About Autolinks and Autotags">autotags</a>,
+<code>[poll:]</code>, <code>[poll_result:]</code>, and <code>[poll_vote:]</code>.</p>
+
+<ul>
+<li>The <code>[poll:]</code> autotag will provide a link to a poll. Simply add
+the poll's ID after the colon. By default, the poll's title will be used as the
+link text. You can provide your own link text after the poll ID (but before the
+closing bracket).</li>
+<li>The <code>[poll_result:]</code> autotag lets you embed the results from a
+poll in a story (or anywhere else where autotags are allowed).</li>
+<li>The <code>[poll_vote:]</code> autotag can be used to embed a poll into an
+article (or anywhere else where autotags are allowed) so that users don't need
+to go to the polls block to vote.</li>
+</ul>
+
+
<div class="footer">
<a href="http://wiki.geeklog.net/">The Geeklog Documentation Project</a><br>
All trademarks and copyrights on this page are owned by their respective owners. Geeklog is copyleft.
diff -r 6e857a94c80e -r 42760e758229 public_html/docs/english/staticpages.html
--- a/public_html/docs/english/staticpages.html Sat Nov 07 15:55:10 2009 +0100
+++ b/public_html/docs/english/staticpages.html Sat Nov 07 18:22:52 2009 +0100
@@ -26,7 +26,7 @@
<li>Static pages can be displayed on Geeklog's <a href="#frontpage">index and topic pages</a> and can even replace it entirely ("splash screen")</li>
<li>"<a href="#cloning">cloning</a>" of existing pages</li>
<li>Makes use of Geeklog's <a href="#url">URL rewrite feature</a></li>
- <li>Provides <code>[staticpage:]</code> and <code>[staticpage_content:]</code> autotags</li>
+ <li>Provides <a href="#autotags">two autotags</a></li>
<li>proper support for Geeklog permissions</li>
</ul>
@@ -135,11 +135,11 @@
<p>To make use of URL rewriting, you will need to set the option "Enable URL Rewriting" to True in Geeklog's Configuration admin panel.</p>
-<h3><a name="delete">Deleting pages with their owner</a></h3>
+<h2><a name="delete">Deleting pages with their owner</a></h2>
<p>As all objects in Geeklog, static pages have an owner (the user that created the static page). When that user's account is deleted for some reason, any static pages owned by that user can either be deleted as well or they can be assigned to another user in Geeklog's Root group.</p>
-<p>In the Configuration admin panel for the static pages plugin, you can set the "Delete Pages with Owner?" option to either "False" (which is also the default), meaning that static pages will not be deleted withtheir owner, but assigned to a member of the Root group instead (the user withthe lowest user ID, most likely the Admin). Setting the option to "True" means that static pages will be deleted when their owner's account is deleted.</p>
+<p>In the Configuration admin panel for the static pages plugin, you can set the "<a href="#desc_delete_pages">Delete Pages with Owner?</a>" option to either "False" (which is also the default), meaning that static pages will not be deleted withtheir owner, but assigned to a member of the Root group instead (the user withthe lowest user ID, most likely the Admin). Setting the option to "True" means that static pages will be deleted when their owner's account is deleted.</p>
<h2><a name="config.php">Configuration</a></h2>
@@ -283,6 +283,22 @@
<td valign="top">Set to true to include static pages that execute PHP.</td></tr>
</table>
+
+<h2><a name="autotags">Autotags</a></h2>
+
+<p>The Static Pages Plugin provides 2 <a href="http://www.geeklog.net/article.php/autolinks" title="geeklog.net: About Autolinks and Autotags">autotags</a>,
+<code>[staticpage:]</code> and <code>[staticpage_content:]</code>.</p>
+
+<ul>
+<li>The <code>[staticpage:]</code> autotag will provide a link to a static page.
+ Simply add the page's ID after the colon. By default, the title of the
+ static page will be used as the link text. You can provide your own link
+ text after the page ID (but before the closing bracket).</li>
+<li>The <code>[staticpage_content:]</code> autotag will be replaced with the
+ contents of the static page in question. This can be useful when you need
+ to use a piece of text in more than one place.</li>
+</ul>
+
<div class="footer">
<a href="http://wiki.geeklog.net/">The Geeklog Documentation Project</a><br>
All trademarks and copyrights on this page are owned by their respective owners. Geeklog is copyleft.
More information about the geeklog-cvs
mailing list