Differences

This shows you the differences between two versions of the page.

--- g2:featureset [2006/01/14 17:25] – g2.stats fgm
+++ g2:featureset [2008/01/06 14:35] – vertical whitespace removal fgm
@@ Line 2: / Line 2: @@
 ====== G2 paths ======
 ===== Defined by G2 =====
@@ Line 10: / Line 7: @@
   * admin/help/g2 : the description of the G2 module
   * admin/settings/g2 : the global settings page for G2
-  * g2 : a page containing an intro to the local G2 implementation (node), along with the alphabar linking to
+  * 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/autocomplete/<start> : the AJAX field setter by start for entries
   * g2/entries/<entry> : the page of entries matching <entry> (can contain slashes)
   * g2/initial/<urlencoded initial segment> : the page of entries starting by "initial segment" (starting substring). Individual first pages of definitions by initial
   * g2/wotd/feed : RSS feed for word of the day
+  * node/add/g2_entry : create a new entry
+  * node/add/g2_entry/someentry : create a new entry for "someentry"
 ===== Used by g2 but not defined by it =====
@@ Line 20: / Line 19: @@
   * node/<nid> : the page for an individual G2 entry
   * taxonomy/term/<tid>[/0/feed] : the page or RSS feed for the entries in G2 (and elsewhere) matching a taxonomy term
 ====== Settings ======
@@ Line 30: / Line 27: @@
   * Toggle activation of XML-RPC services
   * Toggle search hinting
+  * Remoting: allow glossary links to a remote glossary instead of a locally maintained one
   * Homonyms processing:
     * Custom disambiguation node, typically unpublished.
@@ Line 37: / Line 35: @@
 ====== G2 XML-RPC API ======
 ===== g2.alphabar =====
@@ Line 49: / Line 46: @@
           * string link to a page of entries by initial (g2/initial/<urlencoded initial>)
+===== 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 =====
@@ Line 68: / Line 67: @@
           * string entry
           * int nid
 ===== g2.random =====
@@ Line 80: / Line 78: @@
         * int nid
         * string teaser
 ===== g2.wotd =====
@@ Line 97: / Line 92: @@
 ===== g2.stats =====
-  * function g2.stats ($tid = 0, $initial = NULL)
+  * 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
-      * int $published : the number of matching published entries
+      * [0] : the number of matching unpublished entries
-      * int $total : the total number of matching entries
+      * [1] : the number of matching published entries
 ====== Blocks defined by G2 ======
 ===== Blocks =====
   * G2 Alphabar : displays the initial selector pointing to glossary pages
+  * G2 Latest 'n' : displays list of n most recently updated terms
   * G2 Random word : displays term, teaser, and link to definition
-  * G2 Top 10 : displays list of n most requested terms
+  * G2 Top 'n' : displays list of n most requested terms
   * G2 Word of the day
 ===== Blocks configuration =====
@@ Line 126: / Line 114: @@
     * list of initials to be included in alphabar. Defaults to ascii lowercase letters and arabic numerals.
     * maximum length of each row in the alphabar
-  * G2 Top 10
+  * G2 Latest 'n'
-    * number of elements in top (default 10)
+    * number of elements in latest (default 10)
   * G2 Random
     * store latest random entry to avoid duplicates, or don't store it for reduced DB load
     * display taxonomy links for the current entry
+  * G2 Top 'n'
+    * number of elements in top (default 10)
   * G2 WOTD
     * the word of the day