Clean: restructuring the outline

1 files changed, 28 insertions, 21 deletions

diff --git a/coorgi-client.org b/coorgi-client.org
index 17383de..5ec62aa 100644
--- a/coorgi-client.org
+++ b/coorgi-client.org
@@ -33,8 +33,12 @@ to ensure your environment is ready to go:
 
 ** Overview
 
-If you evaluate the following block, it will effectively "eval-buffer"
-on the whole shebang.
+The following block is the source of [[coorgi-client.el]]. It wraps all the
+relevant code blocks into sections and is tangled into the resulting
+source file.
+
+If you evaluate the block, it will effectively "eval-buffer" the whole
+coorgi-client package, as it currently exists in this file.
 
 #+begin_src emacs-lisp :tangle yes :noweb no-export :results silent
   ;;; coorgi-client.el --- A collaborative org document sync client. -*- lexical-binding: t; -*-
@@ -56,6 +60,12 @@ on the whole shebang.
   ;;; coorgi-client.el ends here
 #+end_src
 
+** Syncing Coorgi documents with collaborators
+*** TODO ~coorgi-initialize~ creates the document on the server
+*** TODO Coorgi syncs on the ~after-save-hook~
+*** TODO Coorgi syncs on buffer change if its been idle X time
+
+* Coorgifying an Org-mode document
 ** Parsing, modifying, and re-inserting org data
 
 ~org-element-parse-buffer~ will turn any org document into a parsed
@@ -75,28 +85,12 @@ For example:
     (org-element-interpret-data subject))
 #+end_src
 
-** Syncing Coorgi documents with collaborators
-*** TODO ~coorgi-initialize~ creates the document on the server
-*** TODO Coorgi syncs on the ~after-save-hook~
-*** TODO Coorgi syncs on buffer change if its been idle X time
-
-* Dependencies
-
-#+begin_src emacs-lisp :results silent :noweb-ref dependencies
-  (require 'cl-lib)
-#+end_src
-
-* defvars
-:PROPERTIES:
-:header-args:emacs-lisp+: :noweb-ref defvars :noweb-sep "\n\n" :results silent
-:END:
-
-** coorgi-properties
+** defvar coorgi-properties
 
 This variable stores a list of upcased symbols that appear in the headline
 element's parsed property drawer. 
 
-#+begin_src emacs-lisp
+#+begin_src emacs-lisp :noweb-ref defvars :results silent
   (defvar coorgi-properties '(:COORGI-KEY
 			      :COORGI-LAST-MODIFIED
 			      :COORGI-LAST-MODIFIED-BY
@@ -104,11 +98,12 @@ element's parsed property drawer.
     "List of properties coorgi cares about.")
 #+end_src
 
-* Functions
 ** coorgify-at-point
 
 Converts the current org outline section into a coorgi-node data structure.
 
+*** Implementation
+
 #+name: coorgify-at-point
 #+begin_src emacs-lisp :results none
   (defun coorgify-at-point ()
@@ -332,6 +327,12 @@ as it gets parsed into its various elements.
 #+RESULTS:
 : PASS
 
+
+* Syncing Coorgi documents with collaborators
+** TODO ~coorgi-initialize~ creates the document on the server
+** TODO Coorgi syncs on the ~after-save-hook~
+** TODO Coorgi syncs on buffer change if its been idle X time
+
 * Copyright
 
 #+begin_src emacs-lisp :noweb-ref copyright
@@ -363,3 +364,9 @@ as it gets parsed into its various elements.
   ;; You should have received a copy of the GNU General Public License
   ;; along with this file.  If not, see <https://www.gnu.org/licenses/>.
 #+end_src
+
+* Dependencies
+
+#+begin_src emacs-lisp :results silent :noweb-ref dependencies
+  (require 'cl-lib)
+#+end_src