Update equation recipes

kgryte · kgryte · commit 17161206e25e · 2016-06-18T13:29:27.000-07:00
diff --git a/tools/make/lib/docs/Makefile b/tools/make/lib/docs/Makefile
@@ -4,6 +4,7 @@
 include $(TOOLS_MAKE_LIB_DIR)/docs/src.mk
 include $(TOOLS_MAKE_LIB_DIR)/docs/eqns.mk
 
+
 # TARGETS #
 
 # Generate documentation.
@@ -22,12 +23,3 @@ docs: src-docs
 clean-docs: clean-src-docs
 
 .PHONY: clean-docs
-
-
-# Generate equations.
-#
-# This target inserts DIVs and generates SVG files for all equations in Markdown file.
-
-equations: generate-equations
-
-.PHONY: equations
diff --git a/tools/make/lib/docs/eqns.mk b/tools/make/lib/docs/eqns.mk
@@ -1,36 +1,73 @@
+
 # VARIABLES #
 
-REMARK_RUNNER ?= $(BIN_DIR)/remark
+# Define the path to the [remark][1] executable.
+#
+# To install remark:
+#     $ npm install remark-cli
+#
+# [1]: https://github.com/wooorm/remark/
+
+REMARK ?= $(BIN_DIR)/remark
 
 # Define the path to the remark ignore file:
 REMARK_IGNORE ?= $(CONFIG_DIR)/.remarkignore
 
-# Define plugins:
+# Define the path to the local remark plugins directory:
+REMARK_LOCAL_PLUGINS_DIR ?= $(TOOLS_DIR)/remark/plugins
 
-PLUGIN_FOLDER ?= $(TOOLS_DIR)/remark/plugins
-REMARK_HTML_EQUATIONS_PLUGIN ?= $(PLUGIN_FOLDER)/remark-html-equations
-REMARK_SVG_EQUATIONS_PLUGIN ?= $(PLUGIN_FOLDER)/remark-svg-equations
+# Define paths to local plugins:
+REMARK_HTML_EQUATIONS_PLUGIN ?= $(REMARK_LOCAL_PLUGINS_DIR)/remark-html-equations
+REMARK_SVG_EQUATIONS_PLUGIN ?= $(REMARK_LOCAL_PLUGINS_DIR)/remark-svg-equations
 
 # Define Markdown extensions:
 REMARK_EXT ?= md
 
 # Define the command-line options when invoking the remark executable:
-GENERATE_EQUATIONS_FLAGS ?= \
+REMARK_FLAGS ?= \
 		--ext $(REMARK_EXT) \
-		--ignore-path $(REMARK_IGNORE) \
-		--use $(REMARK_HTML_EQUATIONS_PLUGIN) \
-		--use $(REMARK_SVG_EQUATIONS_PLUGIN)
+		--ignore-path $(REMARK_IGNORE)
 
 # Define output option:
-OUTPUT ?= --output
+REMARK_OUTPUT_FLAG ?= --output
+
 
 # TARGETS #
 
-# Generate equations.
+# Generate HTML equation elements.
+#
+# This target transforms Markdown files containing equation comment markup to include HTML equation elements.
+
+markdown-html-equations: $(NODE_MODULES)
+	$(REMARK) $(MARKDOWN_FILES) \
+		$(REMARK_FLAGS) \
+		--use $(REMARK_HTML_EQUATIONS_PLUGIN) \
+		$(REMARK_OUTPUT_FLAG)
+
+.PHONY: markdown-html-equations
+
+
+# Generate SVG equation files.
+#
+# This target generates SVG equations files from Markdown equation elements.
+
+markdown-svg-equations: $(NODE_MODULES)
+	$(REMARK) $(MARKDOWN_FILES) \
+		$(REMARK_FLAGS) \
+		--use $(REMARK_SVG_EQUATIONS_PLUGIN)
+
+.PHONY: markdown-svg-equations
+
+
+# Processes Markdown files containing equations.
 #
-# This target generates SVG files for all equations in Markdown file.
+# This target processes Markdown files in search for Markdown equation elements. Files containing equation elements are transformed to include HTML equation elements. SVG files are also generated for each equation.
 
-generate-equations: $(NODE_MODULES)
-	$(REMARK_RUNNER) $(GENERATE_EQUATIONS_FLAGS) $(MARKDOWN_FILES) $(OUTPUT)
+markdown-equations: $(NODE_MODULES)
+	$(REMARK) $(MARKDOWN_FILES) \
+		$(REMARK_FLAGS) \
+		--use $(REMARK_HTML_EQUATIONS_PLUGIN) \
+		--use $(REMARK_SVG_EQUATIONS_PLUGIN) \
+		$(REMARK_OUTPUT_FLAG)
 
-.PHONY: generate-equations
+.PHONY: markdown-equations
diff --git a/tools/make/usage.txt b/tools/make/usage.txt
@@ -32,4 +32,3 @@ Usage: make <cmd>
   make clean                  Run all cleanup tasks.
   make clean-node             Remove Node dependencies.
   make inspect.VARIABLE       Print the runtime value of a VARIABLE.
-  make equations              Generate SVGs for equations in Markdown files.
