Documentation: articles/layout_articles_as_manual.php

Class Layout_articles_as_manual extends Layout_interface - Layout articles as in a manual

With this layout each article is considered as being one page of a structured electronic document. This script lists articles like a large table of content, with one line per article.

Articles are ordered based on rank values.

At the level one, entries are based on <h2> HTML tags. At levels two, three and four, entries are ordinary items (i.e., <li>) of compound unordered lists (<ul>).

If some nodes are missing this layout will create dummy entries to maintain the overall structure of the hierarchical tree.

Largely inspired from php manual (www.php.net/manual/en).

This script is a reference file of this system.

Voir aussi:

Licence: GNU Lesser General Public License

Auteurs:

Bernard Paques bernard.paques@bigfoot.com

items_per_page() - The preferred number of items for this layout

function items_per_page()

returns int the optimised count of items fro this layout

The compact format of this layout allows a high number of items to be listed

layout() - List articles as a table of content of a manual

function &layout(&$result, $capability='?')

&$result - resource the SQL result
$capability='?' - string '?' or 'A', to support editors and to impersonate associates, where applicable
returns string the rendered text