g2:featureset
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
g2:featureset [2006/01/03 11:11] – Global settings fgm | g2:featureset [2008/01/06 14:41] – new main page generator setting fgm | ||
---|---|---|---|
Line 2: | Line 2: | ||
====== G2 paths ====== | ====== G2 paths ====== | ||
- | |||
- | |||
- | |||
===== Defined by G2 ===== | ===== Defined by G2 ===== | ||
Line 10: | Line 7: | ||
* admin/ | * admin/ | ||
* admin/ | * admin/ | ||
- | * g2 : a page containing an intro to the local G2 implementation (node), along with the alphabar | + | * g2 : a page containing an intro to the local G2 implementation (node), along with the alphabar. This path can be modified in the site settings for g2 |
* g2/ | * g2/ | ||
* g2/ | * g2/ | ||
* g2/ | * g2/ | ||
* g2/ | * g2/ | ||
+ | * node/ | ||
+ | * node/ | ||
===== Used by g2 but not defined by it ===== | ===== Used by g2 but not defined by it ===== | ||
Line 26: | Line 25: | ||
Most settings are located in the feature blocks, but G2 also has a few global settings. | Most settings are located in the feature blocks, but G2 also has a few global settings. | ||
- | * Custom main page node, typically unpublished. Is used for the glossary home page, wrapped between | + | * Custom main page. Is used for the glossary home page, replaced by an alphabar if empty. Starting with the D5 version, it can be set in either of two ways: |
+ | * by providing the nid of an existing node, typically an unpublished story node. This is the default method | ||
+ | * by providing the name of a node-generating function (starting with the D5 branch). This function must return a " | ||
+ | * a title for the page. If missing, G2 will use its own default | ||
+ | * a body for the page. If missing, G2 will replace it by an alphabar | ||
+ | * a nid, which should be zero | ||
+ | * in both cases, starting with the D5 branch, the validity of the parameter is tested: the nid or function must exist | ||
* Toggle activation of XML-RPC services | * Toggle activation of XML-RPC services | ||
* Toggle search hinting | * Toggle search hinting | ||
+ | * Remoting: allow glossary links to a remote glossary instead of a locally maintained one | ||
* Homonyms processing: | * Homonyms processing: | ||
* Custom disambiguation node, typically unpublished. | * Custom disambiguation node, typically unpublished. | ||
* Auto-jump to definition on single entry match (skip disambiguation page) | * Auto-jump to definition on single entry match (skip disambiguation page) | ||
- | ====== G2 XML-RPC API ====== | + | The settings for the WOTD RSS feed are grouped with the settings for the WOTD block. |
+ | The " | ||
+ | |||
+ | ====== G2 XML-RPC API ====== | ||
===== g2.alphabar ===== | ===== g2.alphabar ===== | ||
Line 46: | Line 55: | ||
* string link to a page of entries by initial (g2/ | * string link to a page of entries by initial (g2/ | ||
+ | ===== g2.latest ===== | ||
- | + | * function g2.latest(int n) array | |
- | + | * parameters | |
- | + | * int n : the maximum number of values returned by the function. This number will be site-limited by the value defined for the latest block, to prevent API abuse | |
- | + | * return: | |
- | + | * array | |
- | + | * struct | |
+ | * string entry | ||
+ | * int nid | ||
===== g2.top ===== | ===== g2.top ===== | ||
Line 65: | Line 76: | ||
* string entry | * string entry | ||
* int nid | * int nid | ||
- | |||
===== g2.random ===== | ===== g2.random ===== | ||
Line 77: | Line 87: | ||
* int nid | * int nid | ||
* string teaser | * string teaser | ||
- | |||
- | |||
===== g2.wotd ===== | ===== g2.wotd ===== | ||
Line 91: | Line 99: | ||
* string teaser | * string teaser | ||
- | ====== Blocks defined by G2 ====== | + | ===== g2.stats |
+ | * function g2.stats ($tid = 0, $initial = NULL) array | ||
+ | * parameters | ||
+ | * int $tid : term to match for counted entries | ||
+ | * string $initial : initial segment to match for counted entries | ||
+ | * return | ||
+ | * [0] : the number of matching unpublished entries | ||
+ | * [1] : the number of matching published entries | ||
+ | |||
+ | ====== Blocks defined by G2 ====== | ||
===== Blocks ===== | ===== Blocks ===== | ||
* G2 Alphabar : displays the initial selector pointing to glossary pages | * G2 Alphabar : displays the initial selector pointing to glossary pages | ||
+ | * G2 Latest ' | ||
* G2 Random word : displays term, teaser, and link to definition | * G2 Random word : displays term, teaser, and link to definition | ||
- | * G2 Top 10 : displays list of n most requested terms | + | * G2 Top ' |
* G2 Word of the day | * G2 Word of the day | ||
- | |||
- | |||
- | |||
- | |||
===== Blocks configuration ===== | ===== Blocks configuration ===== | ||
Line 109: | Line 123: | ||
* list of initials to be included in alphabar. Defaults to ascii lowercase letters and arabic numerals. | * list of initials to be included in alphabar. Defaults to ascii lowercase letters and arabic numerals. | ||
* maximum length of each row in the alphabar | * maximum length of each row in the alphabar | ||
- | * G2 Top 10 | + | * G2 Latest ' |
- | * number of elements in top (default 10) | + | * number of elements in latest |
* G2 Random | * G2 Random | ||
* store latest random entry to avoid duplicates, or don't store it for reduced DB load | * store latest random entry to avoid duplicates, or don't store it for reduced DB load | ||
* display taxonomy links for the current entry | * display taxonomy links for the current entry | ||
+ | * G2 Top ' | ||
+ | * number of elements in top (default 10) | ||
* G2 WOTD | * G2 WOTD | ||
* the word of the day | * the word of the day | ||
Line 119: | Line 135: | ||
* auto-change the word of the day | * auto-change the word of the day | ||
* display taxonomy links for the current entry | * display taxonomy links for the current entry | ||
- | * display link to RSS feed | + | |
+ | | ||
+ | * channel title. Can be set separately from the block title, but reverts to it if nulled | ||
+ | * channel description. Can include %site to dynamically display the site base url. Default value uses this feature. | ||
For all G2 blocks, it is also possible to change both the title and name of the block. | For all G2 blocks, it is also possible to change both the title and name of the block. |
g2/featureset.txt · Last modified: 2020/11/23 17:23 by 127.0.0.1