You've already forked macports-guide
mirror of
https://github.com/macports/macports-guide.git
synced 2026-07-12 18:18:46 -07:00
Eitan Adler
123 lines
3.8 KiB
Makefile
123 lines
3.8 KiB
Makefile
# $Id$
|
|
|
|
# Makefile to generate the MacPorts HTML guide pages.
|
|
# The ports 'docbook-xsl', 'docbook-xml' and 'libxslt' have to be installed.
|
|
# For the guide-dblatex target, the 'dblatex' port is also required.
|
|
|
|
# If your MacPorts isn't installed in /opt/local you have to change PREFIX
|
|
# here.
|
|
|
|
UNAME := $(shell uname)
|
|
|
|
# Prefix of the MacPorts installation.
|
|
PREFIX = /opt/local
|
|
ifeq ($(UNAME), Linux)
|
|
PREFIX = /usr
|
|
endif
|
|
|
|
# Command abstraction variables.
|
|
MKDIR = /bin/mkdir
|
|
CP = /bin/cp
|
|
RM = /bin/rm
|
|
LN = /bin/ln
|
|
ifeq ($(UNAME), Linux)
|
|
SED = /bin/sed
|
|
REINPLACE = $(SED) -i -r
|
|
else
|
|
SED = /usr/bin/sed
|
|
REINPLACE = $(SED) -i '' -E
|
|
endif
|
|
TCLSH = /usr/bin/tclsh
|
|
XSLTPROC = $(PREFIX)/bin/xsltproc
|
|
XMLLINT = $(PREFIX)/bin/xmllint
|
|
DBLATEX = $(PREFIX)/bin/dblatex
|
|
|
|
# Data directories.
|
|
GUIDE = guide
|
|
# Source directories.
|
|
GUIDE_SRC = $(GUIDE)/xml
|
|
# Result directories.
|
|
GUIDE_RESULT = $(GUIDE)/html
|
|
GUIDE_RESULT_CHUNK = $(GUIDE_RESULT)/chunked
|
|
GUIDE_RESULT_DBLATEX = $(GUIDE)/dblatex
|
|
|
|
# Path to the DocBook XSL files.
|
|
DOCBOOK = $(PREFIX)/share/xsl/docbook-xsl
|
|
ifeq ($(UNAME), Linux)
|
|
DOCBOOK = $(PREFIX)/share/xml/docbook/stylesheet/docbook-xsl
|
|
endif
|
|
GUIDE_XSL = $(GUIDE)/resources/single-page.xsl
|
|
GUIDE_XSL_CHUNK = $(GUIDE)/resources/chunk.xsl
|
|
|
|
# DocBook HTML stylesheet for the guide.
|
|
STYLESHEET = docbook.css
|
|
|
|
.PHONY: all guide guide-chunked guide-dblatex clean validate
|
|
|
|
all: guide guide-chunked
|
|
|
|
# Generate the HTML guide using DocBook from the XML sources in $(GUIDE_SRC).
|
|
guide:
|
|
$(MKDIR) -p $(GUIDE_RESULT)
|
|
$(CP) $(GUIDE)/resources/$(STYLESHEET) $(GUIDE_RESULT)/$(STYLESHEET)
|
|
$(CP) $(GUIDE)/resources/images/* $(GUIDE_RESULT)/
|
|
$(CP) $(GUIDE)/resources/*.js $(GUIDE_RESULT)/
|
|
ifeq ($(UNAME), Linux)
|
|
$(LN) -sfn $(DOCBOOK) $(GUIDE)/resources/xsl
|
|
else
|
|
$(LN) -sfh $(DOCBOOK) $(GUIDE)/resources/xsl
|
|
endif
|
|
$(XSLTPROC) --xinclude \
|
|
--output $(GUIDE_RESULT)/index.html \
|
|
$(GUIDE_XSL) $(GUIDE_SRC)/guide.xml
|
|
# Convert all sections (h1-h9) to a link so it's easy to link to them.
|
|
# If someone knows a better way to do this please change it.
|
|
$(REINPLACE) \
|
|
's|(<h[0-9] [^>]*><a id="([^"]*)"></a>)([^<]*)(</h[0-9]>)|\1<a href="#\2">\3</a>\4|g' \
|
|
$(GUIDE_RESULT)/index.html
|
|
|
|
# Generate the chunked HTML guide with one section per file.
|
|
guide-chunked:
|
|
$(MKDIR) -p $(GUIDE_RESULT_CHUNK)
|
|
$(CP) $(GUIDE)/resources/$(STYLESHEET) $(GUIDE_RESULT_CHUNK)/$(STYLESHEET)
|
|
$(CP) $(GUIDE)/resources/images/* $(GUIDE_RESULT_CHUNK)/
|
|
ifeq ($(UNAME), Linux)
|
|
$(LN) -sfn $(DOCBOOK) $(GUIDE)/resources/xsl
|
|
else
|
|
$(LN) -sfh $(DOCBOOK) $(GUIDE)/resources/xsl
|
|
endif
|
|
$(XSLTPROC) --xinclude \
|
|
--output $(GUIDE_RESULT_CHUNK)/index.html \
|
|
$(GUIDE_XSL_CHUNK) $(GUIDE_SRC)/guide.xml
|
|
# Convert all sections (h1-h9) to a link so it's easy to link to them.
|
|
# If someone knows a better way to do this please change it.
|
|
$(REINPLACE) \
|
|
's|(<h[0-9] [^>]*><a id="([^"]*)"></a>)([^<]*)(</h[0-9]>)|\1<a href="#\2">\3</a>\4|g' \
|
|
$(GUIDE_RESULT_CHUNK)/*.html
|
|
# Add the table of contents to every junked HTML file.
|
|
# If someone knows a better way to do this please change it.
|
|
$(TCLSH) toc-for-chunked.tcl $(GUIDE_RESULT_CHUNK)
|
|
|
|
# Generate the guide as a PDF.
|
|
guide-dblatex: SUFFIX = pdf
|
|
guide-dblatex:
|
|
$(MKDIR) -p $(GUIDE_RESULT_DBLATEX)
|
|
$(DBLATEX) \
|
|
--fig-path="$(GUIDE)/resources/images" \
|
|
--type="$(SUFFIX)" \
|
|
--param='toc.section.depth=2' \
|
|
--param='doc.section.depth=3' \
|
|
--output="$(GUIDE_RESULT_DBLATEX)/macports-guide.$(SUFFIX)" \
|
|
$(GUIDE_SRC)/guide.xml
|
|
|
|
# Remove all temporary files generated by guide:.
|
|
clean:
|
|
$(RM) -rf $(GUIDE)/resources/xsl
|
|
$(RM) -rf $(GUIDE_RESULT)
|
|
$(RM) -rf $(GUIDE_RESULT_DBLATEX)
|
|
$(RM) -f guide.tmp.xml
|
|
|
|
# Validate the XML files for the guide.
|
|
validate:
|
|
$(XMLLINT) --xinclude --loaddtd --postvalid --noout $(GUIDE_SRC)/guide.xml
|