Browse Source

Added entry on "docstring"

Matt Lundin 10 years ago
parent
commit
bd94bb4147
1 changed files with 63 additions and 7 deletions
  1. 63 7
      org-glossary.org

+ 63 - 7
org-glossary.org

@@ -221,6 +221,9 @@ Here are a few ideas:
     projects.
 
 * Category
+  :PROPERTIES:
+  :CUSTOM_ID: category
+  :END:
 ** Definition
 Category designates the group an item belongs to. 
 
@@ -275,11 +278,68 @@ for this.
 Here's one way to distinguish between categories and tags: an entry
 can belong to only one category but it can have multiple tags.
 
+* Docstring
+  :PROPERTIES:
+  :CUSTOM_ID: docstring
+  :END:
+
+** Definition
+
+(Note: This definition is not org-mode specific, but is rather a more
+general org-mode/lisp/coding concept. It's included here because
+mailing list posts often reference a "docstring," an obscure phrase
+for anyone not familiar with coding lingo.)
+
+A [[http://en.wikipedia.org/wiki/Docstring][docstring]] is the documentation written as part of a emacs lisp
+variable or a function. It is part of Emacs' wonderful interactive
+help system.
+
+** Details and uses
+
+If you are wondering what a particular org-mode function or variable
+does, the manual is not your only source of information. Carsten has
+also embedded a wealth of resources into the org-mode source code
+itself. These can be easily viewed using Emacs built-in help
+functions.
+
+For instance, let's say you want to learn more about creating a clock
+report in org mode. One way to do this is to type =C-h k= or =M-x
+describe-key= and then to enter the relevant key =C-c C-x-C-r=. This
+will give you the following very helpful information:
+
+#+begin_src 
+
+org-clock-report is an interactive compiled Lisp function in
+`org-clock.el'.
+
+It is bound to C-c C-x C-r, <menu-bar> <Org> <Logging work> <Create
+clock table>.
+
+(org-clock-report &optional arg)
+
+Create a table containing a report about clocked time.
+If the cursor is inside an existing clocktable block, then the table
+will be updated.  If not, a new clocktable will be inserted.
+When called with a prefix argument, move to the first clock table in the
+buffer and update it.
+
+[back]
+
+#+end_src
+
+If you knew the name of the function, you could also locate the same
+information using =C-h f= or =M-x describe-function= and entering
+=org-clock-report=. Or you could use =C-h a= or =apropos-command= 
+to browse all functions that contain the words "org clock".
+
+Finally, if you want to learn more about variables, you can read their
+docstrings by browsing the customize interface (=M-x customize-group
+[RET] org=) or by typing =C-h v= or =M-x describe-variable=).
+
 * Drawers
   :PROPERTIES:
   :CUSTOM_ID: drawers
   :END:
-
 ** Definition
 
 A drawer is a container that can hide information you don't want to
@@ -346,7 +406,6 @@ structure. Entries nested within other entries form a tree.
   :PROPERTIES:
   :CUSTOM_ID: headline
   :END: 
-
 ** Definition
 A headline is the name for an outline heading in an org file.
 
@@ -547,17 +606,13 @@ Note: The "|" separates active from inactive todos.
 You can combine such todo sequences with [[#logging][logging]] in order to keep a
 record of when each event in the sequence happened.
 
-* COMMENT Waiting completion
+* COMMENT Awaiting completion
 ** Agenda filtering
-** Drawer
-
-
 ** CLOCK 
 
 ** Column view
 ** Cycling
 ** DEADLINE 
-** Docstring
 ** Effort estimate
 ** Filetag
 ** Inheritance
@@ -570,6 +625,7 @@ record of when each event in the sequence happened.
 		     
 ** SCHEDULED 
 
+** Restriction lock
 ** Table 
 
 ** Tag