From fddd331edf4bc019fdfab199964c327147087376 Mon Sep 17 00:00:00 2001
From: P. J. McDermott <pjm@nac.net>
Date: Tue, 05 Jun 2012 21:15:56 -0400
Subject: Add notes on {pre,post}-processing scripts.

---
(limited to 'notes')

diff --git a/notes/processing-scripts.txt b/notes/processing-scripts.txt
new file mode 100644
index 0000000..388a507
--- /dev/null
+++ b/notes/processing-scripts.txt
@@ -0,0 +1,40 @@
+MD -> TXT:
+	scripts/preprocmdheaders.pl -n $docdir
+MD -> HTML:
+	scripts/preprocmdheaders.pl -nl $docdir
+	scripts/linkpages.pl $docdir
+	markdown $docdir/index.txt > $docdir/index.html
+	while read file; do \
+			markdown $docdir/$file.txt > $docdir/$file.html
+		done < $docdir/series
+	scripts/postprochtmlheaders.pl -anL $docdir
+
+
+scripts/preprocmdheaders.pl [-ntl] docdir
+	options
+		-n  prepend section numbers to headers
+		-l  handle hyperlinks to sections in text and table of contents
+	pseudocode
+		chapter = 0
+		for each file in $docdir/series:
+			++chapter
+			...
+			for each header:
+				if opt n:
+					...
+				...
+scripts/linkpages.pl docdir
+scripts/postprochtmlheaders.pl [-anL] docdir
+	options
+		-a  add "id" attributes to headers
+		-n  remove section numbers from "id" attributes (use with -a)
+		-L  increment header levels
+
+
+$docdir/
+ +- appendices
+ +- chapters
+ +- first-chapter.md
+ +- reference-stuff.md
+ +- second-chapter.md
+ \- title.md
--
cgit v0.9.1