Browse Source

org-manual: Document "results" macro

* doc/org-manual.org (Macro Replacement): Document "results" macro.
Nicolas Goaziou 7 years ago
parent
commit
61cfd675f3
1 changed files with 5 additions and 0 deletions
  1. 5 0
      doc/org-manual.org

+ 5 - 0
doc/org-manual.org

@@ -11799,6 +11799,11 @@ Org comes with following pre-defined macros:
      specified counter is reset to 1.  You may leave {{{var(NAME)}}}
      empty to reset the default counter.
 
+#+cindex: @samp{results}, macro
+Moreover, inline source blocks (see [[*Structure of Code Blocks]]) use the
+special =results= macro to mark their output.  As such, you are
+advised against re-defining it, unless you know what you are doing.
+
 #+vindex: org-hide-macro-markers
 The surrounding brackets can be made invisible by setting
 ~org-hide-macro-markers~ non-~nil~.