Changeset 2249 for trunk/htdocs/doc/manual/index.html

Timestamp:

07/25/08 02:08:49 (6 months ago)

Author:

rickc

Message:

The user's manual updated to version 0.5. The placement of images in the user handbook tiddler could be better, and the tiddler itself needs to be split into several tiddlers before the next release. Suggestions and edits welcome.

Files:

• trunk/htdocs/doc/manual/index.html (modified) (50 diffs)

trunk/htdocs/doc/manual/index.html

@@ -540 +540 @@
 Here is [http://www.chrisjdavis.org/asides-with-habari another tutorial] for doing inline asides.  That is, asides listed along with primary posts, however with the ability to format them differently.</pre>
 </div>
-<div title="Choosing a Custom Theme" modifier="miklb" modified="200710132257" created="200803130446" wikiformat="mediawiki" server.host="wiki.habariproject.org/w" server.page.revision="694">
-<pre>#REDIRECT [[Creating a Custom Theme]]</pre>
+<div title="Available Plugins" modifier="laserlight" modified="200806260907" created="200807250028" wikiformat="mediawiki" server.host="wiki.habariproject.org/w" server.page.revision="undefined">
+<pre>''Add your plugins to the list!''
+
+The Habari community also maintains the [http://trac.habariproject.org/habari-extras Habari-Extras repository] to house community developed plugins and themes, many of which are not listed here. Plugins can be [http://www.habariproject.org/dist/plugins/ downloaded from the distribution directory].  Currently this repository does not separate stable builds from development builds, so compatibility with various builds of Habari is not guaranteed.  Eventually this will be resolved.
+
+== [http://www.awhitebox.com Ali B. (a.k.a. dmondark)] ==
+[http://www.awhitebox.com/audio-player-plugin-quick-update Audio Player Plugin 0.2]
+''lets you insert a flash-based, mp3 audio player anywhere within your posts or pages.''
+
+[http://www.awhitebox.com/woopra-plugin-for-habari Woopra Plugin 0.3]
+''Add Woopra's tracking code to the footer of your site.''
+
+The plugins below can now be found in the [http://trac.habariproject.org/habari-extras Habari-Extras] repository, and can be [http://www.habariproject.org/dist/plugins/ downloaded from the distribution directory]
+
+'''Recent Comments'''
+''Display the most recent comments in your blog and customize how they are displayed''
+
+'''Blogroll'''
+''Displays a blogroll on your blog''
+
+== [http://myfla.ws Arthus Erea] ==
+The plugins below can now be found in the [http://trac.habariproject.org/habari-extras Habari-Extras] repository, and can be [http://www.habariproject.org/dist/plugins/ downloaded from the distribution directory].
+
+* '''[http://trac.habariproject.org/habari-extras/browser/plugins/aliencontact AlienContact]''' generates and manages an extensible contact form for insertion into pages.
+* '''[http://trac.habariproject.org/habari-extras/browser/plugins/partytime partyTime]''' creates an event content-type for managing events on your Habari blog
+
+== [http://www.andrewdasilva.com/plugins Andrew da Silva] ==
+
+''These plugins can now be found in the [http://trac.habariproject.org/habari-extras Habari-Extras] repository, and can be [http://www.habariproject.org/dist/plugins/ downloaded from the distribution directory]''
+
+'''Feedburner 0.5'''
+''Redirects your Habari feeds through Feedburner.''
+
+'''Google Sitemaps 0.6'''
+''Generates a sitemap.xml when requested.''
+
+'''Gravatar 0.5'''
+''Simple yet effective Gravatar plugin for Habari.''
+
+'''MetaWeblog 0.8.2'''
+''Adds support for the metaWeblog XMLRPC protocol!
+
+'''Route 301 0.5'''
+''Ease your move to Habari, route your old URLs to your new format.''
+
+'''Thickbox 0.1'''
+''Add Thickbox, a lightweight clone of Lightbox using the jQuery library.''
+
+'''OpenSearch 0.1'''
+''Add OpenSearch functionality to Habari''
+
+'''OpenID 0.1'''
+''Add OpenID support to Habari''
+
+== [http://www.nbrightside.com/blog/ Andy C] ==
+[http://www.nbrightside.com/blog/user/files/plugins/quote-0.2.tar.gz Quote]
+''Display a random one-line quote from a user defined list''
+
+== [http://caius.name/ Caius Durling] ==
+[http://qwert.us/habari-markdown Habari Markdown (Updated)]
+''An updated version of drunkenmonkeys markdown plugin.  Applies markdown to the atom feed as well as the http:// content''
+
+== [http://www.chrisjdavis.org/plugins/ Chris J. Davis] ==
+[http://www.chrisjdavis.org/akismet-for-habari Akismet for Habari]
+''Uhhh, yeah Akismet for Habari, like it says.''
+
+[http://www.chrisjdavis.org/cjd-lifestream-1-0 CJD Lifestream 1.0]
+''Lifestream for Habari''
+
+[http://www.chrisjdavis.org/cjd-quick-posts-1-0 CJD Quick Post]
+''Quickly post asides without loading the admin interface with this plugin.''
+
+== [http://drunkenmonkey.org/ Drunken Monkey Labs] ==
+[http://drunkenmonkey.org/projects/habari-markdown Habari Markdown] ''Enables [http://daringfireball.net John Gruber's] [http://daringfireball.net/projects/markdown/ Markdown syntax] for Habari''
+
+[http://drunkenmonkey.org/user/files/habminbar-0.2.tar.gz Habminbar v.0.2] ''Habmin Bar is a small plugin for Habari that adds an admin bar to top of every page for easy access to the admin section. And in the latest version the styling makes it all look beautiful.''
+
+[http://drunkenmonkey.org/projects/jambo Jambo Development Preview] ''Jambo plugin for Habari that will insert a contact form into any post you wish. Just insert &lt;nowiki&gt;&lt;!-- Jambo --&gt;&lt;/nowiki&gt; wherever you want the contact form to be displayed.''
+
+[http://drunkenmonkey.org/user/files/tabasamu.dev.tar.gz Tabasamu Development Preview] ''Tabasamu is a plugin for Habari that allows for the selection of different smilies packages. Smilies packages are a set of text/image smiley replacements which filter the post content and replace all text smilies with their image counterpart.''
+
+== [http://blog.trifolddesigns.com/ Dylan Wreggelsworth] ==
+[http://blog.trifolddesigns.com/textile-2-0-0-plugin-for-habari Habari Textile]
+''Allows Textile 2.0.0 Parsing for articles and pages.''
+
+[http://blog.trifolddesigns.com/pownce-plugin-for-habari Habari Pownce]
+''Show your latest public posts from Pownce.''
+
+== [http://iamgraham.net/ Graham Christensen 'itrebal' ] ==
+[http://iamgraham.net/plugins#adsense Google AdSense]
+''Displays Google AdSense in the sidebar.''
+
+[http://iamgraham.net/plugins#analytics Google Analytics]
+''Adds Google Analytics JS code to track your site using their services.''
+
+[http://iamgraham.net/plugins#commenthttp Comment HTTP Filter]
+''Filters out http:// from comments who's URL is '''only''' http://, leaves &quot;http://&quot; for all other URLs.''
+
+== [http://josedasilva.net/blog/ Jose da Silva ] ==
+[http://josedasilva.net/blog/habari-linkedin-plugin LinkedIn Habari Plugin] ''LinkedIn Plugin for Habari allows you to have the plugin badge in you template on a simple way!''
+* Current Version: 0.1
+* Tested on Habari Versions: DR 0.4
+
+== [http://massimiliano.farinetti.eu Massimiliano Farinetti ] ==
+[http://massimiliano.farinetti.eu/scartari/comment-notifier-for-habari Comment Notifier]
+''Enables comment notification to a selected e-mail address.''
+* Current Version: 0.4
+* Tested on Habari 0.4 and 0.5-alpha (r1382)
+
+== [http://www.twofishcreative.com/michael/blog Michael C. Harris ] ==
+[http://www.twofishcreative.com/michael/blog/publish-quote Publish Quote]
+''Easily quote web sites on your blog using a bookmarklet.''
+
+[http://www.twofishcreative.com/michael/blog/tinymce TinyMCE]
+''Publish posts using the TinyMCE WYSIWYG HTML editor.''
+
+(The following plugins are available on [http://habariproject.org/dist/plugins/ Habari-Extras])
+
+[http://www.habariproject.org/dist/plugins/jwysiwyg.zip jWYSIWYG]
+''Publish posts using the lightweight JQuery-based jWYSIWYG HTML editor.''
+
+[http://www.habariproject.org/dist/plugins/youtubesilo.zip YouTube Media Silo]
+''Access your YouTube videos from within Habari's publish page, for easy embedding.''
+
+[http://www.habariproject.org/dist/plugins/livehelp.zip Live Help]
+''Get live help from Habari developers and users from your Habari admin.''
+
+== [http://blog.tinyau.net/ Raman Ng (a.k.a. tinyau)] ==
+[http://blog.tinyau.net/archives/2007/06/25/habari-rn-code-escape-plugin/ RN Code Escape]
+''Escape &amp;, &lt;, &gt; inside &amp;lt;code&amp;gt;...&amp;lt;/code&amp;gt; block into HTML entities automatically''
+
+[http://blog.tinyau.net/archives/2007/07/02/habari-rn-related-posts-plugin/ RN Related Posts]
+''Show related posts of a post based on tag intersection of tags''
+
+[http://blog.tinyau.net/archives/2007/07/17/habari-rn-related-tags-plugin/ RN Related Tags]
+''Show related tags of a post''
+
+[http://blog.tinyau.net/archives/2007/07/29/habari-rn-flickrrss-plugin/ RN FlickrRSS]
+''Show recent images of Flickr through RSS feed''
+
+[http://blog.tinyau.net/archives/2007/07/29/habari-rn-zooomrrss-plugin/ RN ZooomrRSS]
+''Show recent images of Zooomr through RSS feed''
+
+[http://blog.tinyau.net/archives/2007/08/30/habari-rn-tag-cloud-plugin/ RN Tag Cloud]
+''Show tag cloud of your blog''
+
+[http://blog.tinyau.net/archives/2007/09/22/habari-rn-monthly-archives-plugin/ RN Monthly Archives]
+''Show monthly archives''
+
+[http://blog.tinyau.net/archives/2008/03/12/habari-rn-custom-permalink-plugin/ RN Custom Permalink]
+''Customize permalink structure of every content type and its corresponding comments feed''
+
+== [http://robinadr.com Robin Adrianse ] ==
+[http://robinadr.com/projects/footnotes Footnotes]
+''Adds footnotes to your posts!''
+
+[http://robinadr.com/projects/headcode Headcode]
+''Enables you to Inject your own code into the section of your template, and before the closing tag in your template.''
+
+[http://robinadr.com/projects/underscore_permalinks Underscore Permalinks]
+''changes Habari’s slug creation to use underscores (_) instead of dashes (-).''
+
+== [http://www.morydd.net/ Sean T Evans (a.k.a. Morydd)] ==
+[http://www.morydd.net/habari-magic-tags-0-1 Morydd's Magic Tags]
+''Hide tags begining with &quot;@&quot; from display Tested on DR 0.2)''
+* Current Version: 0.3
+* Tested on Habari Versions: DR 0.2
+(Now avilable on [http://habariproject.org/dist/plugins/ Habari-Extras])
+
+== [http://www.shihui.org/sheng/ Mike Shi] ==
+[http://www.shihui.org/sheng/chinese-plugin-for-habari Chinese Plugin For Habari]
+
+让Habari更好支持中文的插件，主要功能是把中文标题转换成拼音形式，比如标题为“测试”，则生成的URL地址为“ce-shi”,对于标签做同样的操作。
+
+If you can NOT understand the text above, I guess you will not be interested in this plugin, because it is useful (or meaningful) only for people who write blogs in Chinese. You, however, still can get the English introduction from [http://www.shihui.org/sheng/chinese-plugin-for-habari here]
+
+[http://www.shihui.org/sheng/fanfou-plugin-for-habari Fanfou Plugin For Habari]
+
+Fanfou(饭否) is one of twitter's mimics in China. It supplies a badge for showing the lastest messages of you in the sidebar of your blog. I wrote this plugin to make it easy to use it. Maybe it's useless for the people who do not use Fanfou, but I think it's useful for some Chinese people since Fanfou is very popular in China. You can download it at [http://code.google.com/p/habari-chinese-plugin/downloads/list here]
+
+[http://www.shihui.org/sheng/timezone-plugin-for-habari Timezone  Plugin For Habari] '''OMG, there is still a serious bug in it, I will fix it asap. Sorry.'''
+
+Timezone plugin can make your blog's time be shown correctly for your timezone. Active it, and select your timezone in configuration field, and, that's all. The date saved in database is still the server's timezone, so it will not damage your data. You can download from [http://habari-chinese-plugin.googlecode.com/files/timezone_0.8.zip here]
+
+== [http://numberbox.net Elijah Snyder] ==
+[http://numberbox.net/blogs/files/barcampdev.zip barcamp Orlando Developer Day Badge]
+
+[http://numberbox.net/blogs/files/barcampmedia.zip barcamp Orlando Media Day Badge]
+
+Simple plugins to add barcamp badges to your sidebar for [http://barcamporlando.com barcamp Orlando]
+
+These plugins are designed to work &quot;out of the box&quot; with the K2 and other older themes that use act('theme_sidebar_top'), or invoked with $theme-&gt;sidebar_top()
+
+[http://numberbox.net/blogs/files/diggplugin.zip Digg Tags on your posts]
+Simple plugin for a configurable Digg tag on your post content.  Very old, not very useful...
+Invoked with $theme-&gt;digg(&quot;link to article&quot;), for example: $theme-&gt;digg($post-&gt;permalink)
+
+[http://numberbox.net/blogs/files/geshiplugin.zip GeSHi plugin for Habari.]
+GeSHi in Habari!&lt;br/&gt;
+This plugin requires that you download GeSHi yourself.&lt;br/&gt;
+[http://geshi.org Get GeSHi]
+
+[http://numberbox.net/blogs/habaritup-testing Content editor for Habari featuring markItUp! and simpleModal -- IN TESTING!]
+Adds a light weight, extensible jQuery based editor to Habari.
+
+== [http://mikelietz.org/code/habari Mike Lietz] ==
+[http://mikelietz.org/code/habari/geotags.php GeoTags] ''Adds [http://wikipedia.org/wiki/Geotagging Geotag] meta tags to the header, for 0.4.1 and later.''
+
+[http://mikelietz.org/code/habari/counters.php Post Word Count] ''Counts words in a given post, for 0.4.1 and later.''
+
+[http://mikelietz.org/code/habari/counters.php Word Count by Tag] ''Totals word counts for all published posts in with one or more specified tags, for 0.4.1 and later.''
+
+== [http://gopherwood.info wayne] ==
+[http://gopherwood.info/2008/05/19/habari-plugin-post-mailer Post Mailer] ''Be used to mail a copy of post new published to indicated email addresses.''
+
+[http://gopherwood.info/2008/05/21/fckeditor-plugin-for-habari Fckeditor] ''FckEditor plugin for Habari''
+
+[http://gopherwood.info/2008/05/21/syntaxhighlighter-for-habari SyntaxHighlighter for Habari] ''SyntaxHighlighter for Habari is used to highlight source code in your post''
+
+== [http://www.aranel.net Eugene Wee] ==
+[https://launchpad.net/habari-captcha CAPTCHA] ''Provides a CAPTCHA for comment submission.''
+
+Comments are allowed to bypass moderation if the submitter passes the CAPTCHA provided by reCAPTCHA. By default, comment submitters may choose to ignore the CAPTCHA, but this behaviour may be configured through the Habari admin panel.
+* Current version: 1.0b2
+* Compatible with Habari 0.5 (tested on revision 2104)
+* Version 1.0b1 compatible with Habari 0.4.1</pre>
 </div>
-<div title="Code Submisson" modifier="habari" modified="200710161723" created="200710132030" tags="MediaWikiFormat" changecount="2">
-<pre>== Editing the Code ==
+<div title="CSS Coding Standards" modifier="rickc" modified="200807241310" created="200807242317" tags="Category:Manual" wikiformat="mediawiki" server.host="wiki.habariproject.org/w" server.page.revision="undefined">
+<pre>===Shorthand===
+
+It is not only legal to use shorthand CSS, it is in fact recommended to save space. Thus, instead of:
+&lt;pre&gt;
+font-family: Helvetica, Sans-Serif;
+font-size: 1em;
+&lt;/pre&gt;
+You should use:
+&lt;pre&gt;
+font: 1em Helvetica, Sans-Serif;
+&lt;/pre&gt;
+This isn't applicable however if using shorthand means overwriting cascading CSS with similar CSS simply for the sake of using shorthand. The following example for instance, is wrong:
+&lt;pre&gt;
+ul li {
+    margin: 0 5px;
+}
+
+ul li.last-child {
+    margin: 0 5px 0 10px;
+}
+&lt;/pre&gt;
+This would be the correct way of changing the left margin:
+&lt;pre&gt;
+ul li.last-child {
+    margin-left: 10px;
+}
+&lt;/pre&gt;
+In this way, you retain any changes higher up in the hierarchy.
+
+===Colors Shorthand===
+
+Using shorthand colors is entirely legal, like so:
+&lt;pre&gt;
+body {
+    color: #222;
+}
+&lt;/pre&gt;
+Color names (white, black, cyan) should not be used, because implementation on all browsers is not the same. Additionally, they provide no added benefit beyond convenience.
+
+===Proprietary Styling===
+
+It is fully legal to use proprietary styling rules, like for instance -webkit-box-shadow, as long as it doesn't degrade the user experience in any significant way on browsers where it isn't supported.
+
+Also, when doing so, e.g. with -webkit-border-radius, it is recommended that any other similar implementations be supported as well; in this case -moz-border-radius.
+
+===Remember the Cascade===
+
+It is easy to forget the cascading part of CSS in the heat of battle. However, in order to make future editing of admin.css as effortless as possible, remembering to contain the cascading of styling is paramount.
+
+Because of this, it is also suggested that the !important rule not be used, as it most often means that the cascading isn't being handled properly elsewhere in the CSS.
+
+===Sections===
+
+Some files, like /system/admin/css/admin.css, can grow quite large, and require some measure of organization to remain usable. For this, 'sections' are employed, which loosely group definitions by the elements they affect. admin.css for instance has sections like The Basics, The Menubar, The Menu, Dropbuttons and so on and so forth.
+
+A section is a commented capitalized section title with a dash to the extreme left in the comment:
+&lt;pre&gt;
+/*- FORMS */
+&lt;/pre&gt;
+And is always preceeded by two line breaks and followed by a single line space.
+
+Sub-sections can be helpful for dividing large sections. The sub-section title should be descriptive, so browsing the CSS file is swift. They looks like this:
+&lt;pre&gt;
+/*-- FORM BUTTONS */
+&lt;/pre&gt;
+The use of the dash to the left of the inside of the comment, makes it easy to step-search through the CSS file for a section, sub-section or simple comment, but searching for '/*- ' (sections) or '/*-- ' (sub-sections) or simply '/* ' (comments).
+
+===CSS Code Layout===
+
+All style definitions should have one line of space before and after. All CSS rules should be indented with a single tab space, and have a single space between the colon and the value of the rule. Finally, a semi-colon should follow all values, regardless of whether the value is the last in the style definition.
+
+Like so:
+&lt;pre&gt;
+body {
+    background: #eee;
+    font: 1em Helvetica, 'Trebuchet MS', Sans-Serif;
+    color: #222;
+}
+&lt;/pre&gt;
+As with any well-formed CSS, notice the apostrophe's around 'Trebuchet MS' and the defaulting to Sans-Serif.
+
+For readability and consistency's sake, it is generally recommended that even single-line style definitions be set up in the above manner, and not on a single line, like so:
+&lt;pre&gt;
+body { color: #222; }
+&lt;/pre&gt;
+===Inline Comments===
+
+When a piece of CSS is inserted for non-obvious reasons, it can be a good idea to leave a small comment for others so as to not have it removed later because it didn't seem to make any immediate sense.
+
+Comments are inserted on the right-hand side of the element they are meant for. If they cover an entire block of code, it would look like this:
+&lt;pre&gt;
+body { /* Something insightful goes here */
+    background: #eee;
+    font: 1em Helvetica, 'Trebuchet MS', Sans-Serif;
+    color: #222;
+}
+&lt;/pre&gt;
+If they cover only a single element, it would look like this:
+&lt;pre&gt;
+body {
+    background: #eee;
+    font: 1em Helvetica, 'Trebuchet MS', Sans-Serif; /* Trebuchet MS doesn't match Helvetica well */
+    color: #222;
+}
+&lt;/pre&gt;
+
+===Complete Example===
+
+This is how the end of one section and the beginning of a new, complete with inline comments, might look:
+
+&lt;pre&gt;
+body {
+    background: #eee;
+    font: 1em Helvetica, 'Trebuchet MS', Sans-Serif;
+    color: #222;
+}
+
+
+/*- HEADERS */
+
+h1, h2 {
+    color: #111; /* Redundant comment */
+    font-size: 2em;
+}
+
+h2 {
+    font-size: 1.5em;
+}
+&lt;/pre&gt;
+
+[[Category:Manual]]</pre>
+</div>
+<div title="Classes/QueryRecord" modifier="dmondark" modified="200803031924" created="200807242317" tags="Category:Manual" wikiformat="mediawiki" server.host="wiki.habariproject.org/w" server.page.revision="undefined">
+<pre>A single instance of QueryRecord represents a single query result row.  QueryRecord also serves as the base class for derivative classes that provide row-level data access.  QueryRecord is, in many ways, the fundamental building block of Habari.
+
+==Using QueryRecord==
+
+QueryRecord provides basic functions that allow Habari to interact with the single row of data.  The properties of a QueryRecord object represent the field values of the row.  
+
+To obtain an instance of QueryRecord with data, call one of these static methods on the DB class:
+;get_row():Returns a single QueryRecord instance for the single row retrieved
+;get_results():Returns an array of QueryRecord instances, one per row returned in the query
+
+For example:
+&lt;code&gt;
+ $record = DB::get_row('SELECT id, bar FROM foo WHERE id = 1');
+ echo $record-&gt;bar;
+&lt;/code&gt;
+
+The code above firsts queries the database for a record containing the fields &lt;tt&gt;id&lt;/tt&gt; and &lt;tt&gt;bar&lt;/tt&gt; from the table 'foo' where the 'id' field is equal to 1.  The single record (only one is returned by &lt;tt&gt;DB::get_row()&lt;/tt&gt;) is stored in &lt;tt&gt;$record&lt;/tt&gt; as an instance of the QueryRecord class.  The property &lt;tt&gt;bar&lt;/tt&gt; referenced as &lt;tt&gt;$record-&gt;bar&lt;/tt&gt; contains the value of the 'bar' field returned by the query.  Similarly, although this is not shown, the 'id' field is assigned to &lt;tt&gt;$record-&gt;id&lt;/tt&gt;.
+
+By echoing the value of &lt;tt&gt;$record-&gt;bar&lt;/tt&gt;, the value of that field is output.
+
+==Updating a Record==
+
+By changing the values of these properties and calling the update() method on the object, the QueryRow can commit that data back to the database.  For example:
+
+&lt;code&gt;
+ $record = DB::get_row('SELECT id, bar FROM foo WHERE id = 1');
+ $record-&gt;bar = 'hello';
+ $record-&gt;update('foo', array('id'));
+&lt;/code&gt;
+
+As with the prior example, the values of the fields 'id' and 'bar' have been queried into an instance of QueryRecord.
+
+The &lt;tt&gt;$record-&gt;bar&lt;/tt&gt; is then assigned the value 'hello'.  This prepares the new data for update in the database.  The value of &lt;tt&gt;$record-&gt;bar&lt;/tt&gt; will contain 'hello' after this assignment.  
+
+To update the record in the database, the &lt;tt&gt;update()&lt;/tt&gt; method is called.  In QueryRecord, update() accepts two parameters.  The first is the table to which the data will be written and the second is an array of fields that will be used to match the data in the object to the correct row in the database.
+
+In this case, the table updated is 'foo', and the value of &lt;tt&gt;$record-&gt;id&lt;/tt&gt; will be matched against the field 'id' in the database.  Any record in the database with a matching id value will have its fields updated to the other property values of &lt;tt&gt;$record&lt;/tt&gt;
+
+==Inserting a Record==
+
+QueryRecord can also be used to insert new records into a table.  For example:
+
+&lt;code&gt;
+ $record = new QueryRecord(
+   array('bar'=&gt;'hello')
+ );
+ $record-&gt;insert('foo');
+&lt;/code&gt;
+
+In the above example, a new instance of QueryRecord is created and asigned to &lt;tt&gt;$record&lt;/tt&gt;.  The values of the properties in the new QueryRecord are built from the associative array that is passed to the QueryRecord constructor.  The keys of the array become the object's properties, and the values of the array become those properties' values.  After creating &lt;tt&gt;$record&lt;/tt&gt; as above, the value of &lt;tt&gt;$record-&gt;bar&lt;/tt&gt; would be set to 'hello'.
+
+Calling &lt;tt&gt;$record-&gt;insert()&lt;/tt&gt; inserts the property values into the specified table, in this case, 'foo'.
+
+In order for this to work correctly, all of the values required to insert a row into a table must have been set as properties of the QueryRecord object.  Note that in this example, the 'id' field is omitted with the assumption that it is an auto_increment primary key in the 'foo' table.
+
+After the row is inserted, the value of 'id' *will not* be set in &lt;tt&gt;$record-&gt;id&lt;/tt&gt;.  This must be done manually using &lt;tt&gt;DB::last_insert_id()&lt;/tt&gt;, which is often handled from a subclass, as described in the Extending QueryRecord section below.
+
+==Deleting a Record==
+
+This is fundamentally the same as updating a row, except it deletes the row from the table that has fields with the matching values.
+
+&lt;code&gt;
+ $record-&gt;delete('foo', array('id'));
+&lt;/code&gt;
+
+==Extending QueryRecord==
+
+As part of Habari's Object-Oriented approach, other classes can extend the QueryRecord class to provide additional methods that interact with QueryRecords that contain a specific type of data.  For example, the Post class extends QueryRecord to provide additional methods that are post-specific.  The class that extends QueryRecord [http://en.wikipedia.org/wiki/Inheritance_%28computer_science%29 inherits] all of the methods of QueryRecord in addition to any that it provides on its own.
+
+In most cases, a QueryRecord is not the class of a row.  A row is usually requested as one of QueryRecord's descendant classes.
+
+Many classes extend the QueryRecord class.  The following classes all inherit from QueryRecord:
+;Post: Represents a single post
+;Comment: Represents a single comment
+;LogEntry: Represents a single entry in the event log
+;CronJob: Represents a single periodically executed task
+;RewriteRule: Represents a single rewrite rule
+;User: Represents a single user
+
+The classes above represent wildly different functionality and and data representations; yet they each extend the base QueryRecord class.  By providing this core functionality for descendant classes, extended classes don't need to duplicate code.  
+
+QueryRecord descendants map to database tables of the same name, and most of the properties of the descendants map the columns of that table.  For example, the Post table is used to store Post object data.  The Post object has fields 'id', 'title', and 'content', among others.  These fields are also columns in the 'posts' table in the database.
+
+The Post class also provides special functionality that is associated only to posts.  For example, every post has a status value.  In the database, this status value is stored as an integer.  Because it's often easier to work with the names of these status, the Post class provides the ability to accept either the integer or the string as the value of the poperty, but always stores the value in the database as an integer.  This is just one example of what additional functionality a subclass of QueryRecord can provide.
+
+One of the more significant additions a subclass can make is to override the &lt;tt&gt;update()&lt;/tt&gt; and &lt;tt&gt;insert()&lt;/tt&gt; methods of QueryRecord.  By creating having its own &lt;tt&gt;update()&lt;/tt&gt; method, a class can identify the correct table and key fields that are used to update that row in the database.  This allows a subclass instance to omit the table and keyfields parameters in the call to update.  So when updating a post, instead of this:
+
+&lt;code&gt;$record-&gt;update('foo', array('id'));&lt;/code&gt;
+
+You would simply call this:
+
+&lt;code&gt;$post-&gt;update();&lt;/code&gt;
+
+Using a subclass, you can transparently assign the value of DB::last_insert_id() to the keyfield property of the object.  This will allow you to update the object after it is inserted without having to manually retrieve the key values each time.  So when inserting a post, instead of this, where the &lt;tt&gt;id&lt;/tt&gt; property must be set manually:
+
+&lt;code&gt;
+ $record = new QueryRecord(/* post field data */);
+ $record-&gt;insert('posts');
+ $record-&gt;id = DB::last_insert_id();
+ $record-&gt;title = 'new title';
+ $record-&gt;update('post', array('id'));
+&lt;/code&gt;
+
+You would simply call this:
+
+&lt;code&gt;
+ $post = new Post(/* post field data*/);
+ $post-&gt;insert();
+ $post-&gt;title = 'new title';
+ $post-&gt;update();
+&lt;/code&gt;
+
+It's not that the assignment doesn't need to be made at all, but that it takes place in the Post class (which extends QueryRecord) so that you need not repeat it whenever you insert a new post.
+
+Please review the documentation for the classes that extend QueryRecord for the details of functionality that they provide beyond QueryRecord itself.
+
+
+QueryRecord provides the following:
+* [http://us.php.net/manual/en/language.oop5.overloading.php overloaded] __get(), __set() and __isset()
+* exclude_fields() and list_excluded_fields(), for identifying properties handled exclusively by the database
+* insert(), for adding data to the database
+* to_array(), to permit array operations on the object (like &lt;code&gt;foreach&lt;/code&gt;)
+* get_url_args(), which returns an array of the values represented by the object
+* update(), for recording modified values to the database
+* delete(), for deleting an item from the database
+
+{{developer}}
+
+[[Category:Manual]]</pre>
+</div>
+<div title="Code Submisson" modifier="michaeltwofish" modified="200805241224" created="200807242317" tags="Category:Manual" wikiformat="mediawiki" server.host="wiki.habariproject.org/w" server.page.revision="undefined">
+<pre>Contributions to the Habari codebase made by the wider community are incredibly important. This page describes the process that developers should follow to submit code to Habari.
+
+== Editing the Code ==
 First, you must [[Installation#Downloading_Habari|download the source code]] from SVN.
 
 Then, following the [[Coding Standards]], make your changes to the code.
 
-Next, create a .diff file of the changes you have made. Here is an example of how to do this, where ''filename.php'' is the name of the file you've changed, and ''rXXX'' is the version you've made the change to.
-&lt;pre&gt; svn diff filename.php &gt; filename.php.rXXX.diff &lt;/pre&gt;
+Next, create an appropriately named patch file of the changes you have made. For example, if you have made code changes to the file ''filename.php'' at revision 1701, you could run the command &lt;pre&gt; svn diff filename.php &gt; filename.php.r1701.diff &lt;/pre&gt;
 
 Then, attach your .diff file to the appropriate issue in the [http://trac.habariproject.org/habari issue tracker].
 
-Other users will then be able to apply your patch to test its compatibility with other configurations, and once tested and approved a comitter will then be able to apply your patch to the code to become a part of '''Habari'''
-</pre>
+Other users will then be able to apply your patch to test its compatibility with other configurations, and once tested and approved a comitter will then be able to apply your patch to the code to become a part of Habari.
+
+{{developer}}
+
+[[Category:Manual]]</pre>
 </div>
-<div title="Coding Standards" modifier="Massimiliano" modified="200802022119" created="200803130446" tags="Category:Manual" wikiformat="mediawiki" server.host="wiki.habariproject.org/w" server.page.revision="1200">
+<div title="Coding Standards" modifier="blakej" modified="200806231617" created="200807242317" tags="Category:Manual" wikiformat="mediawiki" server.host="wiki.habariproject.org/w" server.page.revision="undefined">
 <pre>These are the Coding Standards for Habari:
 
@@ -564 +1056 @@
 *conditionals have the opening brace on the same line: &lt;code&gt;if ( foo == bar ) {&lt;/code&gt;
 *on an else condition, closing brace on new line, else and opening brace on same line: &lt;code&gt;} ''[line break]'' else {&lt;/code&gt;
-*Classes are named like so: &lt;code&gt;ClassName&lt;/code&gt;
+*Classes are named like so: &lt;code&gt;ClassName&lt;/code&gt; ''[http://en.wikipedia.org/wiki/UpperCamelCase UpperCamelCase]''
 *Variables are named with underscores: &lt;code&gt;variable_name&lt;/code&gt;
 *spaces inside parentheses and operators: ( parentheses ), &lt;code&gt;foo == bar&lt;/code&gt;
-*no space before assignment, space after: &lt;code&gt;$foo= bar&lt;/code&gt;
+*spaces before and after assignment: &lt;code&gt;$foo = bar&lt;/code&gt;
+*Single line comments should use the // comment format; multi-line comments should use the /* */ format
+*Calls through the DB class should use the brace syntax for table names: &lt;code&gt;DB::query( 'SELECT * FROM {table}' );&lt;/code&gt;
+*Where HTML and PHP is mixed in templates, [http://au.php.net/alternative_syntax| PHP's alternative control syntax] should be used.
 
 {{developer}}
@@ -573 +1068 @@
 [[Category:Manual]]</pre>
 </div>
-<div title="Creating A Plugin" modifier="Massimiliano" modified="200802022118" created="200803130446" tags="Category:Manual" wikiformat="mediawiki" server.host="wiki.habariproject.org/w" server.page.revision="1199">
-<pre>Habari's functionality can be modified or extended using plugins, which are written in PHP. Writing a plugin for Habari is extremely simple.
-
-The steps below describe in detail how to create a plugin for Habari, and provide some examples of the sorts of things that can be done with a plugin.
-
-== Step 1: Create The Plugin Class File ==
-
-Create a new directory in your &lt;tt&gt;/user/plugins&lt;/tt&gt; directory that uses the name of your plugin.  As an example, you could create: &lt;tt&gt;/user/plugins/mysample&lt;/tt&gt;
-
-In that directory, create a php file that contains the name of your plugin (the same as the directory) plus &lt;tt&gt;.plugin.php&lt;/tt&gt; added to the end.  For our example, we would create:  &lt;tt&gt;/user/plugins/mysample/mysample.plugin.php&lt;/tt&gt;
-
-== Step 2: Create the Base Plugin Class == 
-
-All plugins in Habari must extend the core &lt;tt&gt;Plugin&lt;/tt&gt; class.  This allows the system to easily find and register your plugin. The following code creates a plugin called &lt;tt&gt;MyPlugin&lt;/tt&gt;.
-
-&lt;code&gt;
- class MyPlugin extends Plugin
- {
-   function info()
-   {
-     return array(
-       'name' =&gt; 'My Plugin',
-       'version' =&gt; '1.0',
-       'url' =&gt; 'http://habariproject.org/',
-       'author' =&gt; 'Habari Community',
-       'authorurl' =&gt; 'http://habariproject.org/',
-       'license' =&gt; 'Apache License 2.0',
-       'description' =&gt; 'Description',
-     );
-   }
- }
-&lt;/code&gt;
-
-The &lt;tt&gt;info()&lt;/tt&gt; member of the plugin is _required_.  It indicates the basic plugin information.  If you want your plugin to appear properly in Habari's list of plugins in the admin, then you need to provide these fields at a minimum:
-
-;name: The name of the plugin as it will appear in the admin console.
-;version: The version of your plugin.  It is important that this version number be compatible with PHP's [http://php.net/version_compare version_compare()] function if you want your plugin to be compatible with the habariproject.org update beacon.
-;url: The URL location of your plugin.  This will be used to create a link to your plugin from the admin console.
-;author: The name of the author of your plugin.  (Your name!)
-;authorurl: The URL location of your blog/web site if any.
-;license: The distribution license of your plugin.
-;description: Description of your plugin.
-
-You should not create an instance of your plugin (&lt;tt&gt;$foo = new MyPlugin()&lt;/tt&gt;) within your plugin class file.  Habari will find your plugin and create an instance of it for you when your plugin is activated.  It is able to do this because your plugin extends the core &lt;tt&gt;Plugin&lt;/tt&gt; class.  (If your plugin requires a separate class, Habari won't create an instance of it, because it wouldn't extend &lt;tt&gt;Plugin&lt;/tt&gt;.)
-
-== Step 3: Add Actions and Filters ==
-
-The plugin system in Habari is based on Actions and Filters.
-
-An Action occurs when a certain event in the software takes place.  For example, when a post is saved or displayed an Action is triggered.  An Action notifies your plugin that the event has taken place, allowing your plugin to perform some function.  Values that are passed to an action cannot be changed.
-
-A Filter is similar to an Action but allows your plugin to change data that will be used by the system when an event occurs.  Filters are passed the value of a parameter to filter, and return that parameter, possibly having altered it in some way.  Some Filters also pass additional parameters to give plugins extra information.  An example is a Filter that responds to a comment submission and returns the &quot;spamminess&quot; of the comment.  The value that is returned from a Filter is passed to subsequent Filters as the first parameter, and is eventually used as the value for the filtered item.
-
-Each Action or Filter has a name called a &quot;hook name&quot; that represents an event.  A plugin &quot;hook&quot; is the place in the code where Habari checks to see if any plugins need to be informed of an event.  A hook is either an Action or a Filter.  See [[Plugin Hooks]] for more information on plugin hooks, including a list of available Actions and Filters.  A plugin &quot;sink&quot; is one of the actual functions that is executed when the plugin hook code is run. Creating sinks that are activated for specific hooks is as simple as adding a method to your class with the appropriate name, either &lt;tt&gt;filter_hook_name&lt;/tt&gt; or &lt;tt&gt;action_hook_name&lt;/tt&gt;.
-
-=== Action Example ===
-
-Assume that you want your plugin to perform a task whenever the system has finished loading all plugins.  The hook name of this hook is &lt;tt&gt;plugins_loaded&lt;/tt&gt;.  &lt;tt&gt;plugins_loaded&lt;/tt&gt; is an Action.
-
-To sink this action, create a new method in your plugin like so:
-
-&lt;code&gt;
- function action_plugins_loaded()
- {
-   Utils::debug('Hello!');
- }
-&lt;/code&gt;
-
-The prefix of &lt;tt&gt;action_&lt;/tt&gt; in your function name tells Habari that you are creating a sink for an Action.  The &lt;tt&gt;plugins_loaded&lt;/tt&gt; part of the function name tells Habari what hook you want to sink.
-
-When you activate the plugin with this function in it, the &quot;Hello!&quot; message will be displayed inside the pink debug box immediately after all active plugins are loaded.
-
-Some Actions will pass values to the sink methods.  These values can be checked and acted upon.
-
-=== Filter Example ===
-
-Assume that you want your plugin to check the spamminess of a comment.  The hook name of a hook that will do this is &lt;tt&gt;spam_filter&lt;/tt&gt;.  &lt;tt&gt;spam_filter&lt;/tt&gt; is a Filter.
-
-To sink this Filter, create a new method in your plugin like so:
-
-&lt;code&gt;
- function filter_spam_filter($rating, $comment, $handler_vars)
- {
-   if ( strpos( $comment-&gt;content, 'viagra' ) ) {
-     $rating++;
-   }
-   return $rating;
- }
-&lt;/code&gt;
-
-The prefix of &lt;tt&gt;filter_&lt;/tt&gt; in your function name tells Habari that you are creating a sink for a Filter.  The &lt;tt&gt;spam_filter&lt;/tt&gt; part of the function name tells Habari what hook you want to sink.
-
-When you activate the plugin with this method, Habari will pass every submitted comment through it.  The function looks for the word &quot;viagra&quot; in the content of the comment, and upon finding it, increases the spam rating of the comment.  
-
-Finally, the rating is returned for use by the next plugin, and by the system.  Note that even when no adjustment is made to the value of &lt;tt&gt;$rating&lt;/tt&gt; it *must* be returned, otherwise the system will not have a value to process.
-
-In this sink method, the &lt;tt&gt;$handler_vars&lt;/tt&gt; parameter is provided to the method by the system, but it is not used by the method.  This parameter could have been omitted in the method declaration, but it might be useful to leave it there for future use.
-
-=== XMLRPC Example ===
-
-Implementing XMLRPC via plugins is very easy by use of a special prefix for a plugin function.
-
-&lt;code&gt;
- function xmlrpc_namespace__function($param1, $param2, ...);
-&lt;/code&gt;
-
-A hook implemented in this way uses the &quot;namespace&quot; part of the hook name as the XMLRPC namespace, and the &quot;function&quot; part as the XMLRPC function.  The two are separated by two underscore characters.
-
-Values passed from to this hook function are those interpreted by processing the incoming values posted to Habari's XMLRPC endpoint.
-
-To return a properly formatted XMLRPC value, simply return a standard PHP data type.  This will be converted into a proper XMLRPC response by the plugin system.
-
-== Step 4: Common Plugin Tasks ==
-
-The previous steps provide instructions for constructing the basic structure of a Habari plugin.  With that knowledge, leveraging the many plugin hooks is a simple task.
-
-What follows are a few things that are common tasks when creating a plugin.
-
-=== Add Output to a Theme ===
-
-So, you have created your killer plugin and want to provide theme developers a chance to show off your work.  Based on the action example above, you can do something like this:
-
-&lt;code&gt;
- function action_add_template_vars( $theme ) {
- {
-   $theme-&gt;yourvariable= 'Sweet Plugin Output';
- }
-&lt;/code&gt;
-
-This makes &lt;tt&gt;$yourvariable&lt;/tt&gt; available in the theme, where you can do something like 
-
-&lt;code&gt;
-&lt;?php echo $yourvariable ?&gt;
-&lt;/code&gt;
-
-and that will output the value directly in the theme template file.
-
-=== Use FormUI to Create an Options Page ===
-
-Adding an options control to your plugin is also very easy, and most users will be more comfortable with setting the options via the admin panel than editing plugin code directly. Thankfully Habari provides a mechanism called FormUI tha