diff options
| author | Grant Shangreaux <grant@unabridgedsoftware.com> | 2022-11-19 19:54:25 -0600 |
|---|---|---|
| committer | Grant Shoshin Shangreaux <shoshin@cicadas.surf> | 2022-11-19 20:00:47 -0600 |
| commit | adabff309b7116b0c37e0aeae65b5013474b4d7f (patch) | |
| tree | 8363dc5107f7d43ebe6c75215eeee5583e6c174b | |
| parent | f73ec300022d1ea70b0134002e8ddc603be873fe (diff) | |
Add: documentation to coorgi-properties defvar
| -rw-r--r-- | coorgi-client.el | 2 | ||||
| -rw-r--r-- | coorgi-client.org | 16 |
2 files changed, 11 insertions, 7 deletions
diff --git a/coorgi-client.el b/coorgi-client.el index 526cc70..42ae1b5 100644 --- a/coorgi-client.el +++ b/coorgi-client.el @@ -29,7 +29,7 @@ :COORGI-LAST-MODIFIED :COORGI-LAST-MODIFIED-BY :COORGI-VERSION) - "List of properties coorgi cares about.") + "List of properties the Coorgi server cares about.") (defun coorgi--find-headline (headline org-data) (car (org-element-map org-data 'headline diff --git a/coorgi-client.org b/coorgi-client.org index 5ec62aa..8f52939 100644 --- a/coorgi-client.org +++ b/coorgi-client.org @@ -87,18 +87,22 @@ For example: ** defvar coorgi-properties -This variable stores a list of upcased symbols that appear in the headline -element's parsed property drawer. +Coorgi utilizes org-mode's headline properties in order to track and sync +changes between collaborators. They also make it easier to find and update +the various elements within an org document. ~coorgi-properties~ holds +a list of keyword symbols which correspond to properties defined +in a headline's property drawer. They are upcased to match the way +~org-element-parse-buffer~ returns them in a headline's data structure. #+begin_src emacs-lisp :noweb-ref defvars :results silent (defvar coorgi-properties '(:COORGI-KEY :COORGI-LAST-MODIFIED :COORGI-LAST-MODIFIED-BY :COORGI-VERSION) - "List of properties coorgi cares about.") + "List of properties the Coorgi server cares about.") #+end_src -** coorgify-at-point +** defun coorgify-at-point Converts the current org outline section into a coorgi-node data structure. @@ -250,7 +254,7 @@ a cow another cow #+end_src -** coorgi--find-headline +** defun coorgi--find-headline We need to used the parsed version of the org buffer to look up the elements we're turning into coorgi nodes and get the relevant data to pack it up recursively. @@ -298,7 +302,7 @@ we're turning into coorgi nodes and get the relevant data to pack it up recursiv (:parent #2))))) #+end_src -** coorgi--find-property-drawer +** defun coorgi--find-property-drawer It is useful to know whether or not a headline has a property drawer. |