org-export-reference: Document get-category and get-node-property functions
authorNicolas Goaziou <n.goaziou@gmail.com>
Sat, 3 Nov 2012 10:34:30 +0000 (11:34 +0100)
committerNicolas Goaziou <n.goaziou@gmail.com>
Sat, 3 Nov 2012 10:34:30 +0000 (11:34 +0100)
dev/org-export-reference.org

index 8a97b28..5d00b97 100644 (file)
@@ -1438,6 +1438,19 @@ by the exporter.
 
    See also: [[#read-attribute][~org-export-read-attribute~]].
 
+** ~org-export-get-category~
+   :PROPERTIES:
+   :CUSTOM_ID: get-category
+   :END:
+
+   Return category associated to a given element or object.  Unlike to
+   the ~:category~ property from headlines and inlinetasks, this
+   function handles inheritance and ~CATEGORY~ keywords.  Therefore,
+   it should be the preferred way to retrieve a category during
+   export.
+
+   See also: [[#get-node-property][~org-export-get-node-property~]].
+
 ** ~org-export-get-coderef-format~
    :PROPERTIES:
    :CUSTOM_ID: get-coderef-format
@@ -1524,6 +1537,19 @@ by the exporter.
    [[#get-parent-paragraph][~org-export-get-parent-paragraph~]],
    [[#get-previous-element][~org-export-get-previous-element~]].
 
+** ~org-export-get-node-property~
+   :PROPERTIES:
+   :CUSTOM_ID: get-node-property
+   :END:
+
+   Return the node property associated to an element or object.  If
+   the element is an headline, this is equivalent to reading the
+   property with ~org-element-property~.
+
+   Though, this function can optionally handle inheritance.
+
+   See also: [[#get-category][~org-export-get-category~]].
+
 ** ~org-export-get-ordinal~
    :PROPERTIES:
    :CUSTOM_ID: get-ordinal