Skip to content

Commit 18e8d15

Browse files
Improve building of target docs
FossilOrigin-Name: 9da76bc24a45f203f6d8012b5fd5df653f26b33bd5e21b3d411e0132d019fb82
1 parent 48b5b71 commit 18e8d15

File tree

1 file changed

+75
-64
lines changed

1 file changed

+75
-64
lines changed

Makefile

+75-64
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# This file is part of Solo Forth
44
# http://programandala.net/en.program.solo_forth.html
55

6-
# Last modified: 202007152236.
6+
# Last modified: 202010012031.
77
# See change log at the end of the file.
88

99
# ==============================================================
@@ -286,37 +286,37 @@ trdosepubp: \
286286
html: gplusdoshtml plus3doshtml trdoshtml
287287

288288
.PHONY: gplusdoshtml
289-
gplusdoshtml: gplusdoshtmla gplusdoshtmlp
289+
gplusdoshtml: gplusdoshtmla
290290

291291
.PHONY: gplusdoshtmla
292292
gplusdoshtmla: \
293-
doc/gplusdos_solo_forth_manual.html
293+
doc/gplusdos_solo_forth_manual.html.gz
294294

295295
.PHONY: gplusdoshtmlp
296296
gplusdoshtmlp: \
297-
doc/gplusdos_solo_forth_manual.dbk.pandoc.html
297+
doc/gplusdos_solo_forth_manual.dbk.pandoc.html.gz
298298

299299
.PHONY: plus3doshtml
300-
plus3doshtml: plus3doshtmla plus3doshtmlp
300+
plus3doshtml: plus3doshtmla
301301

302302
.PHONY: plus3doshtmla
303303
plus3doshtmla: \
304-
doc/plus3dos_solo_forth_manual.html
304+
doc/plus3dos_solo_forth_manual.html.gz
305305

306306
.PHONY: plus3doshtmlp
307307
plus3doshtmlp: \
308-
doc/plus3dos_solo_forth_manual.dbk.pandoc.html
308+
doc/plus3dos_solo_forth_manual.dbk.pandoc.html.gz
309309

310310
.PHONY: trdoshtml
311-
trdoshtml: trdoshtmla trdoshtmlp
311+
trdoshtml: trdoshtmla
312312

313313
.PHONY: trdoshtmla
314314
trdoshtmla: \
315-
doc/trdos_solo_forth_manual.html
315+
doc/trdos_solo_forth_manual.html.gz
316316

317317
.PHONY: trdoshtmlp
318318
trdoshtmlp: \
319-
doc/trdos_solo_forth_manual.dbk.pandoc.html
319+
doc/trdos_solo_forth_manual.dbk.pandoc.html.gz
320320

321321
.PHONY: odt
322322
odt: gplusdosodt plus3dosodt trdosodt
@@ -338,17 +338,14 @@ pdf: gplusdospdf plus3dospdf trdospdf
338338

339339
.PHONY: gplusdospdf
340340
gplusdospdf: \
341-
doc/gplusdos_solo_forth_manual.pdf.zip \
342341
doc/gplusdos_solo_forth_manual.pdf.gz
343342

344343
.PHONY: plus3dospdf
345344
plus3dospdf: \
346-
doc/plus3dos_solo_forth_manual.pdf.zip \
347345
doc/plus3dos_solo_forth_manual.pdf.gz
348346

349347
.PHONY: trdospdf
350348
trdospdf: \
351-
doc/trdos_solo_forth_manual.pdf.zip \
352349
doc/trdos_solo_forth_manual.pdf.gz
353350

354351
# ==============================================================
@@ -816,7 +813,7 @@ backgrounds/current.scr: backgrounds/current.pbm
816813
zip -9 $@ $<
817814

818815
%.gz: %
819-
gzip -9 --force --keep $<
816+
gzip -9 --force $<
820817

821818
%.html: %.adoc
822819
asciidoctor --out-file=$@ $<
@@ -867,6 +864,9 @@ tmp/doc.README.linked.adoc: README.adoc
867864
--epub-chapter-level=3 \
868865
--output=$@ $<
869866

867+
# XXX REMARK -- Pandoc is not used anymore to create an HTML, because the
868+
# glossary links don't work:
869+
870870
%.dbk.pandoc.html: %.dbk
871871
pandoc \
872872
--from docbook \
@@ -879,8 +879,8 @@ tmp/doc.README.linked.adoc: README.adoc
879879
--to odt \
880880
--output=$@ $<
881881

882-
# XXX REMARK -- 2020-04-05: This PDF is not build by default anymore, because the links
883-
# don't work:
882+
# XXX REMARK -- 2020-04-05: This PDF is not build by default anymore, because
883+
# the links don't work:
884884

885885
%.html.pandoc.pdf: %.html
886886
pandoc \
@@ -1373,50 +1373,54 @@ oldbackup:
13731373
# https://sites.google.com/site/zxgraph/home/einar-saukas/fonts
13741374
# http://www.worldofspectrum.org/infoseekid.cgi?id=0027130
13751375

1376-
# 2017-07-22: Add DocBook and EPUB experimental versions of the manual.
1376+
# 2017-07-22: Add DocBook and EPUB experimental versions of the
1377+
# manual.
13771378
#
13781379
# 2017-12-05: Don't make a +3DOS 180 KiB boot disk anymore.
13791380
#
13801381
# 2017-12-07: Fix rule of +3DOS boot disk.
13811382
#
1382-
# 2018-02-27: Move editors from the library disk to the games disk and rename
1383-
# it, because the library didn't fit a TR-DOS disk image.
1383+
# 2018-02-27: Move editors from the library disk to the games disk and
1384+
# rename it, because the library didn't fit a TR-DOS disk image.
13841385
#
1385-
# 2018-03-10: Add `not_ready` to exclude modules under development. Needed for
1386-
# <src/lib/meta.test.forth2012-test-suite.fs>, which is being adapted.
1386+
# 2018-03-10: Add `not_ready` to exclude modules under development.
1387+
# Needed for <src/lib/meta.test.forth2012-test-suite.fs>, which is
1388+
# being adapted.
13871389
#
1388-
# 2018-04-05: Remove the old code that made the disks containing also the
1389-
# library. Fix name of TR-DOS disk 1.
1390+
# 2018-04-05: Remove the old code that made the disks containing also
1391+
# the library. Fix name of TR-DOS disk 1.
13901392
#
1391-
# 2018-04-07: Update after the renaming of program modules (games, block
1392-
# editors and `edit-sound`).
1393+
# 2018-04-07: Update after the renaming of program modules (games,
1394+
# block editors and `edit-sound`).
13931395
#
1394-
# 2018-04-10: Replace `htmldoc` with `asciidoctor-pdf` for making the PDF
1395-
# versions of the manual.
1396+
# 2018-04-10: Replace `htmldoc` with `asciidoctor-pdf` for making the
1397+
# PDF versions of the manual.
13961398
#
13971399
# 2018-04-11: Create gzipped PDF.
13981400
#
1399-
# 2018-04-17: Link the Forth words of the manual to the glossary, using the new
1400-
# `--annex` option of Glosara. Fix: make the +3DOS and TR-DOS manuals depend
1401-
# also on the Z80 flags notation document.
1401+
# 2018-04-17: Link the Forth words of the manual to the glossary,
1402+
# using the new `--annex` option of Glosara. Fix: make the +3DOS and
1403+
# TR-DOS manuals depend also on the Z80 flags notation document.
14021404
#
14031405
# 2018-06-04: Split the TR-DOS library into two disks.
14041406
#
14051407
# 2018-06-10: Rename TR-DOS phony recipes.
14061408
#
14071409
# 2018-06-12: Add taptools to the list of requirements.
14081410
#
1409-
# 2018-06-15: Prepare the list of exception codes that will be included in the
1410-
# manual.
1411+
# 2018-06-15: Prepare the list of exception codes that will be
1412+
# included in the manual.
14111413
#
14121414
# 2018-06-16: Finish the exception codes lists.
14131415
#
1414-
# 2018-07-20: Convert exception codes into tables instead of definition lists.
1416+
# 2018-07-20: Convert exception codes into tables instead of
1417+
# definition lists.
14151418
#
1416-
# 2018-07-21: Add `--attribute DOS` to Asciidoctor commands, to build the
1417-
# manuals using Asciidoctor's conditional preprocessor directives. Add
1418-
# `[%autowidth] to the tables of exception codes. Set an Asciidoctor attribute
1419-
# "dosname" instead of replacing the "%DOS%" mark with `sed`.
1419+
# 2018-07-21: Add `--attribute DOS` to Asciidoctor commands, to build
1420+
# the manuals using Asciidoctor's conditional preprocessor directives.
1421+
# Add `[%autowidth] to the tables of exception codes. Set an
1422+
# Asciidoctor attribute "dosname" instead of replacing the "%DOS%"
1423+
# mark with `sed`.
14201424
#
14211425
# 2018-07-22: Add a header to the tables of exception codes.
14221426
#
@@ -1426,52 +1430,59 @@ oldbackup:
14261430
#
14271431
# 2020-02-28: Add the _Z80 instructions_ annex to the manual.
14281432
#
1429-
# 2020-02-29: Make the zip and gzip rules common to all cases. Generalize the
1430-
# interface to build the manual in any format for any DOS. Split the long
1431-
# command lines by parameters. Get the Solo Forth version only once, store it
1432-
# in a variable and pass it to Asciidoctor as a parameter, instead of replacing
1433-
# a markup in the source file. Add Vim folding markers. Build PDF also with
1434-
# Pandoc (and wkhtmltopdf as PDF-engine). Build also a ODT version of the
1435-
# manuals.
1433+
# 2020-02-29: Make the zip and gzip rules common to all cases.
1434+
# Generalize the interface to build the manual in any format for any
1435+
# DOS. Split the long command lines by parameters. Get the Solo Forth
1436+
# version only once, store it in a variable and pass it to Asciidoctor
1437+
# as a parameter, instead of replacing a markup in the source file.
1438+
# Add Vim folding markers. Build PDF also with Pandoc (and wkhtmltopdf
1439+
# as PDF-engine). Build also a ODT version of the manuals.
14361440
#
1437-
# 2020-03-01: Build EPUB also with asciidoctor-epub3. Fix prerequites: README
1438-
# and manual skeleton.
1441+
# 2020-03-01: Build EPUB also with asciidoctor-epub3. Fix prerequites:
1442+
# README and manual skeleton.
14391443
#
14401444
# 2020-03-03: Fix prerequisite: exceptions file.
14411445
#
14421446
# 2020-04-03: Replace "docbook" filename extension with "dbk".
14431447
#
1444-
# 2020-04-05: Deprecate the PDF build by Pandoc from HTML. Simplify the
1445-
# filenames of the manuals built by Asciidoctor EPUB3 and Asciidoctor PDF. Fix
1446-
# the building of DocBook (the DOS label attribute was not passed, and the
1447-
# corresponding Asciidoctor conditions failed, making the DOS-spcific contents
1448-
# missing). Dont't build OpenDocument by default. Add rules to build the
1449-
# DocBook directly. Build an HTML manual also with Pandoc.
1448+
# 2020-04-05: Deprecate the PDF build by Pandoc from HTML. Simplify
1449+
# the filenames of the manuals built by Asciidoctor EPUB3 and
1450+
# Asciidoctor PDF. Fix the building of DocBook (the DOS label
1451+
# attribute was not passed, and the corresponding Asciidoctor
1452+
# conditions failed, making the DOS-spcific contents missing). Dont't
1453+
# build OpenDocument by default. Add rules to build the DocBook
1454+
# directly. Build an HTML manual also with Pandoc.
14501455
#
1451-
# 2020-04-06: Split the rules to build EPUB and HTML: one rule for every DOS
1452-
# and converter.
1456+
# 2020-04-06: Split the rules to build EPUB and HTML: one rule for
1457+
# every DOS and converter.
14531458
#
1454-
# 2020-04-13: Add `--epub-chapter-level` to Pandoc, to force the huge glossary
1455-
# XHTML file be splitted in subchapters into the EPUB.
1459+
# 2020-04-13: Add `--epub-chapter-level` to Pandoc, to force the huge
1460+
# glossary XHTML file be splitted in subchapters into the EPUB.
14561461
#
1457-
# 2020-04-17: Test attribute `epub-chapter-level` to Asciidoctor EPUB3, just
1458-
# added to the future version following v0.5.0.alpha.15.
1462+
# 2020-04-17: Test attribute `epub-chapter-level` to Asciidoctor
1463+
# EPUB3, just added to the future version following v0.5.0.alpha.15.
14591464
#
14601465
# 2020-04-27: Add attribute `epub-chapter-level`, after the fixes in
14611466
# Asciidoctor EPUB3 v0.5.0.alpha.17.dev.
14621467
#
1463-
# 2020-05-04: Add the apps to the glossary (actually, only `edit-sound`).
1468+
# 2020-05-04: Add the apps to the glossary (actually, only
1469+
# `edit-sound`).
14641470
#
14651471
# 2020-05-05: Add the editors to the glossary.
14661472
#
14671473
# 2020-06-04: Add the tests to the glossary.
14681474
#
1469-
# 2020-06-17: Save error output of Asciidoctor EPUB3 to log files, to detect
1470-
# wrong cross-references. Add rule "epuba" to build the EPUBs only with
1471-
# Asciidoctor EPUB3.
1475+
# 2020-06-17: Save error output of Asciidoctor EPUB3 to log files, to
1476+
# detect wrong cross-references. Add rule "epuba" to build the EPUBs
1477+
# only with Asciidoctor EPUB3.
1478+
#
1479+
# 2020-07-13: Fix compressed versions of PDF: make gzip keep the input
1480+
# files. Add titles to the exception codes tables.
14721481
#
1473-
# 2020-07-13: Fix compressed versions of PDF: make gzip keep the input files.
1474-
# Add titles to the exception codes tables.
1482+
# 2020-10-01: Compress only with gzip (deactivate zip); remove the
1483+
# uncompressed originals; compress also HTML. Deprecate HTML built
1484+
# from DocBook by Pandoc: the glossary IDs are lost in the process and
1485+
# the links don't work.
14751486

14761487
# ==============================================================
14771488

0 commit comments

Comments
 (0)