summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile36
-rw-r--r--README9
-rwxr-xr-xsrc/index-pages.sh35
-rwxr-xr-xsrc/index-terms.sh33
-rwxr-xr-xsrc/index.sh122
-rw-r--r--src/lib/create_table7
-rw-r--r--src/lib/insert8
7 files changed, 118 insertions, 132 deletions
diff --git a/Makefile b/Makefile
index 096ceee..14031d1 100644
--- a/Makefile
+++ b/Makefile
@@ -10,10 +10,34 @@ INDEX_FILE = $(RESOURCES_DIR)/docSet.dsidx
ICON_FILE = $(DOCSET_DIR)/icon.png
ARCHIVE_FILE = $(DOCSET_NAME).tgz
+SRC_ICON = src/icon.png
+
MANUAL_URL = http://www.gnu.org/software/make/manual/make.html_node.tar.gz
MANUAL_FILE = tmp/make.html_node.tar.gz
-DOCSET = $(INFO_PLIST_FILE) $(INDEX_FILE) $(ICON_FILE)
+ERROR_DOCSET_NAME = $(error DOCSET_NAME is unset)
+WARNING_MANUAL_URL = $(warning MANUAL_URL is unset)
+ERROR_MANUAL_FILE = $(error MANUAL_FILE is unset)
+.phony: err warn
+
+ifndef DOCSET_NAME
+err: ; $(ERROR_DOCSET_NAME)
+endif
+
+ifndef MANUAL_FILE
+err: ; $(ERROR_MANUAL_FILE)
+endif
+
+ifndef MANUAL_URL
+warn:
+ $(WARNING_MANUAL_URL)
+ $(MAKE) all
+endif
+
+DOCSET = $(INFO_PLIST_FILE) $(INDEX_FILE)
+ifdef SRC_ICON
+DOCSET += $(ICON_FILE)
+endif
all: $(DOCSET)
@@ -47,11 +71,11 @@ $(DOCUMENTS_DIR): $(RESOURCES_DIR) $(MANUAL_FILE)
$(INFO_PLIST_FILE): src/Info.plist $(CONTENTS_DIR)
cp src/Info.plist $@
-$(INDEX_FILE): src/index.sh $(DOCUMENTS_DIR)
+$(INDEX_FILE): src/index-pages.sh $(DOCUMENTS_DIR)
rm -f $@
- src/index.sh $@ $(DOCUMENTS_DIR)/*.html
- src/index.sh -i $@ $(DOCUMENTS_DIR)/Concept-Index.html
- src/index.sh -i -c "Function Variable Directive" $@ $(DOCUMENTS_DIR)/Name-Index.html
+ src/index-pages.sh $@ $(DOCUMENTS_DIR)/*.html
+ src/index-terms.sh "Entry" $@ $(DOCUMENTS_DIR)/Concept-Index.html
+ src/index-terms.sh "Directive" $@ $(DOCUMENTS_DIR)/Name-Index.html
$(ICON_FILE): src/icon.png $(DOCSET_DIR)
- cp src/icon.png $@
+ cp $(SRC_ICON) $@
diff --git a/README b/README
index 5ddd230..e84ff6a 100644
--- a/README
+++ b/README
@@ -2,6 +2,7 @@ Here is a script and a Makefile for generating a GNU Make docset for Dash.
- GNU Make: http://www.gnu.org/software/make/
- Dash: https://kapeli.com/dash
+- dash-docset-generation-template: https://github.com/lshprung/dash-docset-generation-template
To generate a docset from the latest edition of the GNU Make Manual, simply
execute `make` from the same directory as this README file. The latest edition
@@ -10,7 +11,7 @@ will be downloaded from www.gnu.org and packaged appropriately.
Requirements:
- any POSIX-compliant shell
-- curl
-- make
-- pup
-- sqlite3
+- curl - https://curl.se/
+- make - https://www.gnu.org/software/make/
+- pup - https://tracker.debian.org/pkg/pup
+- sqlite3 - https://www.sqlite.org/index.html
diff --git a/src/index-pages.sh b/src/index-pages.sh
new file mode 100755
index 0000000..99531b7
--- /dev/null
+++ b/src/index-pages.sh
@@ -0,0 +1,35 @@
+#!/usr/bin/env sh
+
+# shellcheck source=./lib/create_table
+. "$(dirname "$0")"/lib/create_table
+# shellcheck source=./lib/insert
+. "$(dirname "$0")"/lib/insert
+
+DB_PATH="$1"
+shift
+
+get_title() {
+ FILE="$1"
+
+ pup -p -f "$FILE" 'title text{}' | \
+ tr -d \\n | \
+ sed 's/(GNU make)//g' | \
+ sed 's/\"/\"\"/g'
+}
+
+insert_pages() {
+ # Get title and insert into table for each html file
+ while [ -n "$1" ]; do
+ unset PAGE_NAME
+ unset PAGE_TYPE
+ PAGE_NAME="$(get_title "$1")"
+ PAGE_TYPE="Guide"
+ if [ -n "$PAGE_NAME" ]; then
+ insert "$DB_PATH" "$PAGE_NAME" "$PAGE_TYPE" "$(basename "$1")"
+ fi
+ shift
+ done
+}
+
+create_table "$DB_PATH"
+insert_pages "$@"
diff --git a/src/index-terms.sh b/src/index-terms.sh
new file mode 100755
index 0000000..f74af03
--- /dev/null
+++ b/src/index-terms.sh
@@ -0,0 +1,33 @@
+#!/usr/bin/env sh
+
+# shellcheck source=./lib/create_table
+. "$(dirname "$0")"/lib/create_table
+# shellcheck source=./lib/insert
+. "$(dirname "$0")"/lib/insert
+
+TYPE="$1"
+shift
+DB_PATH="$1"
+shift
+
+insert_index_terms() {
+ # Get each term from an index page and insert
+ while [ -n "$1" ]; do
+ grep -Eo "<a href.*</a>:" "$1" | while read -r line; do
+ insert_term "$line"
+ done
+
+ shift
+ done
+}
+
+insert_term() {
+ LINK="$1"
+ NAME="$(echo "$LINK" | pup -p 'a text{}' | sed 's/\"\"//g' | tr -d \\n)"
+ PAGE_PATH="$(echo "$LINK" | pup -p 'a attr{href}')"
+
+ insert "$DB_PATH" "$NAME" "$TYPE" "$PAGE_PATH"
+}
+
+create_table "$DB_PATH"
+insert_index_terms "$@"
diff --git a/src/index.sh b/src/index.sh
deleted file mode 100755
index 3b4cacd..0000000
--- a/src/index.sh
+++ /dev/null
@@ -1,122 +0,0 @@
-#!/usr/bin/env sh
-
-create_table() {
- sqlite3 "$DB_PATH" "CREATE TABLE IF NOT EXISTS searchIndex(id INTEGER PRIMARY KEY, name TEXT, type TEXT, path TEXT);"
- sqlite3 "$DB_PATH" "CREATE UNIQUE INDEX IF NOT EXISTS anchor ON searchIndex (name, type, path);"
-}
-
-get_title() {
- FILE="$1"
-
- pup -p -f "$FILE" 'title text{}' | \
- tr -d \\n | \
- sed 's/(GNU make)//g' | \
- sed 's/\"/\"\"/g'
-}
-
-get_type() {
- LINK="$(echo "$1" | sed 's/#[^#]*$//')"
- LINK_TITLE="$(get_title "$2/$LINK")"
-
- set -- $POSSIBLE_TYPES
-
- while [ -n "$1" ]; do
- if echo "$LINK_TITLE" | grep -iq "$1"; then
- echo "$1"
- return
- fi
- shift
- done
-
- echo "Entry"
-}
-
-insert() {
- NAME="$1"
- TYPE="$2"
- PAGE_PATH="$3"
-
- sqlite3 "$DB_PATH" "INSERT INTO searchIndex(name, type, path) VALUES (\"$NAME\",\"$TYPE\",\"$PAGE_PATH\");"
-}
-
-insert_index_terms() {
- # Get each term from an index page and insert
- while [ -n "$1" ]; do
- grep -Eo "<a href.*></a>:" "$1" | while read -r line; do
- insert_term "$line" "$(dirname "$1")"
- done
-
- shift
- done
-}
-
-
-insert_pages() {
- # Get title and insert into table for each html file
- while [ -n "$1" ]; do
- unset PAGE_NAME
- unset PAGE_TYPE
- PAGE_NAME="$(get_title "$1")"
- if [ -n "$PAGE_NAME" ]; then
- PAGE_TYPE="Guide"
- insert "$PAGE_NAME" "$PAGE_TYPE" "$(basename "$1")"
- fi
- shift
- done
-}
-
-insert_term() {
- LINK="$1"
- PAGE_DIR="$2"
-
- NAME="$(echo "$LINK" | pup -p 'a text{}' | tr -d \\n | sed 's/"/\"\"/g')"
- TYPE="$INDEX_TYPE"
- PAGE_PATH="$(echo "$LINK" | pup -p 'a attr{href}')"
- if [ -n "$POSSIBLE_TYPES" ]; then
- TYPE="$(get_type "$PAGE_PATH" "$PAGE_DIR")"
- elif [ -z "$TYPE" ]; then
- TYPE="Entry"
- fi
-
- insert "$NAME" "$TYPE" "$PAGE_PATH"
-}
-
-TYPE="PAGES"
-
-# Check flags
-while true; do
- case "$1" in
- -c|--check)
- # List of space-separated possible index entry types (overwrites -t)
- shift
- POSSIBLE_TYPES="$1"
- shift
- ;;
- -i|--index)
- # Set the script to handle index pages
- TYPE="INDEX"
- shift
- ;;
- -t|--type)
- # Set a type for index entries
- shift
- INDEX_TYPE="$1"
- shift
- ;;
- *)
- break
- esac
-done
-
-DB_PATH="$1"
-shift
-
-create_table
-case "$TYPE" in
- PAGES)
- insert_pages "$@"
- ;;
- INDEX)
- insert_index_terms "$@"
- ;;
-esac
diff --git a/src/lib/create_table b/src/lib/create_table
new file mode 100644
index 0000000..a783c50
--- /dev/null
+++ b/src/lib/create_table
@@ -0,0 +1,7 @@
+create_table() {
+ DB_PATH="$1"
+
+ sqlite3 "$DB_PATH" "CREATE TABLE IF NOT EXISTS searchIndex(id INTEGER PRIMARY KEY, name TEXT, type TEXT, path TEXT);"
+ sqlite3 "$DB_PATH" "CREATE UNIQUE INDEX IF NOT EXISTS anchor ON searchIndex (name, type, path);"
+}
+
diff --git a/src/lib/insert b/src/lib/insert
new file mode 100644
index 0000000..31c1b4c
--- /dev/null
+++ b/src/lib/insert
@@ -0,0 +1,8 @@
+insert() {
+ DB_PATH="$1"
+ NAME="$2"
+ TYPE="$3"
+ PAGE_PATH="$4"
+
+ sqlite3 "$DB_PATH" "INSERT INTO searchIndex(name, type, path) VALUES (\"$NAME\",\"$TYPE\",\"$PAGE_PATH\");"
+}