コミット: ecd113b7c40fcd83cb924a3fdf3ac7665f5a7d56 - groff-pdfmark (hg)

Reference Documentation: PDF Publishing with GNU Troff

コミットメタ情報

• リビジョン: ecd113b7c40fcd83cb924a3fdf3ac7665f5a7d56 (tree)
• 日時: 2023-03-31 22:41:10
• 作者: Keith Marshall <keith@user...>
• コミッター: Keith Marshall

ログメッセージ

Improve selectivity of pdfroff's blank-page removal feature.

* pdfroff.sh (--no-kill-null-pages): Accept an optional argument,
with permitted values of "all", "body", or "toc"; interpret to set...
(TC_FILTER, BD_FILTER): ...these new internal-use variables, which
subsequently establish the scope of operation for...
(PDFROFF_COLLATE): ...this internal filter.

* pdfroff.1.man (--no-kill-null-pages): Document argument usage.

* tmac/spdf.tmac (TC) [PHASE>1]: Make it a no-op.

変更サマリ

• modified: pdfroff.1.man
• modified: pdfroff.sh
• modified: tmac/spdf.tmac

差分

diff -r 7fed1c1a83d2 -r ecd113b7c40f pdfroff.1.man
--- a/pdfroff.1.man	Wed Mar 29 18:59:09 2023 +0100
+++ b/pdfroff.1.man	Fri Mar 31 14:41:10 2023 +0100
@@ -56,7 +56,8 @@
 .SY pdfroff
 .RI [ groff-option\  \&.\|.\|.\&]
 .RB [ \-\-no\-toc\-relocation ]
-.RB [ \-\-no\-kill\-null\-pages ]
+.RB [ \-\-no\-kill\-null\-pages [ =\c
+.IR where ]]
 .if t .br
 .RB [ \-\-no\-reference\-dictionary ]
 .RB [ \-\-reference\-dictionary=\c
@@ -391,7 +392,6 @@
 has completed PDF document formatting;
 this may be useful when debugging formatting problems.
 .
-.
 .IP
 See section \[lq]Files\[rq] below for a description of the temporary
 files used by
@@ -432,7 +432,8 @@
 .
 .
 .TP
-.B \-\-no\-kill\-null\-pages
+.BR \-\-no\-kill\-null\-pages [ =\c
+.IR where ]
 While preparing for simulation of the manual collation step,
 which is traditionally required to relocate a
 .I "table of contents"
@@ -447,6 +448,48 @@
 .I \%pdfroff
 to leave them in place.
 .
+.IP
+It may be noted that, in
+.IR \%pdfroff 's
+default mode of operation,
+entirely blank pages are discarded
+.I throughout
+the finished document;
+the optional
+.I where
+argument,
+which may take any
+.I one
+of the values,
+.BR toc ,
+.BR body ,
+or
+.BR any ,
+permits a finer degree of control over \%blank-page removal.
+The default behaviour,
+when
+.B \%\-\-no\-kill\-null\-pages
+is specified
+.I without
+any argument,
+is equivalent to the effect of specifying
+.BR \%\-\-no\-kill\-null\-pages=all ;
+this suppresses the removal of blank pages throughout the
+.I entire
+document.
+More often,
+it will be desired to leave blank pages in place
+within the body of the document,
+while removing them from the table of contents;
+this may be achieved by specifying
+.BR \%\-\-no\-kill\-null\-pages=body .
+Conversely,
+although perhaps less usefully,
+blank pages may be removed from the document body,
+while leaving them in place within the table of contents,
+by specifying
+.BR \%\-\-no\-kill\-null\-pages=toc .
+.
 .
 .TP
 .BI \-\-pdf\-output= name

diff -r 7fed1c1a83d2 -r ecd113b7c40f pdfroff.sh
--- a/pdfroff.sh	Wed Mar 29 18:59:09 2023 +0100
+++ b/pdfroff.sh	Fri Mar 31 14:41:10 2023 +0100
@@ -196,8 +196,8 @@
   REFFILE=${GROFF_TMPDIR}/pdf$$.ref
 #
   CS_DATA=""
-  TC_DATA=${GROFF_TMPDIR}/pdf$$.tc
-  BD_DATA=${GROFF_TMPDIR}/pdf$$.ps
+  TC_DATA=${GROFF_TMPDIR}/pdf$$.tc TC_FILTER=$TC_DATA
+  BD_DATA=${GROFF_TMPDIR}/pdf$$.ps BD_FILTER=$BD_DATA
 #
 # Initialise 'groff' format control settings,
 # to discriminate table of contents and document body formatting passes.
@@ -303,7 +303,7 @@
 		 	normally required to position the table of contents at the
 		 	start of a PDF document.
 
-		  --no-kill-null-pages
+		  --no-kill-null-pages[=all|body|toc]
 		 	Suppress the 'null page' elimination filter, which is used
 		 	to remove the excess blank pages produced by the collation
 		 	algorithm used for 'toc-relocation'.
@@ -355,11 +355,18 @@
                ;;
 
 	     --no-toc-relocation)
-	       TC_DATA="" TOC_FORMAT=""
+	       TC_DATA="" TC_FILTER="" TOC_FORMAT=""
 	       ;;
 
 	     --no-kill-null-pages)
-	       PDFROFF_COLLATE="$CAT" PDFROFF_KILL_NULL_PAGES=""
+	       OPTARG=`echo $OPTARG | $SED y/ALTCBODY/altcbody/`
+	       case $OPTARG in all | body | toc) ;; *)
+		 test -n "$OPTARG" && { echo >&2 "$CMD: option '$1' is invalid"
+		   exit 1
+		 } || OPTARG="all" ;;
+	       esac
+	       case $OPTARG in all | body) BD_FILTER="" ;; esac
+	       case $OPTARG in all | toc) TC_FILTER="" ;; esac
 	       ;;
 #
 #          any other non-null match must have matched more than one defined case,
@@ -603,7 +610,7 @@
 #	...reproducing the effect of the '--no-toc-relocation' option, when
 #	no enabling hint has been provided.
 #
-	TC_DATA="" TOC_FORMAT=""
+	TC_DATA="" TC_FILTER="" TOC_FORMAT=""
       fi
     fi
 #
@@ -716,26 +723,31 @@
   then
     exec > $PDF_OUTPUT
   fi
+
+  test -n "$BD_FILTER" && { BD_DATA="-"; test -n "$TC_FILTER" && TC_DATA=""
+  } || test -n "$TC_FILTER" && TC_DATA="-"
 #
 # (This 'sed' script is a hack, to eliminate redundant blank pages).
 #
-  ${PDFROFF_COLLATE-"$SED"} ${PDFROFF_KILL_NULL_PAGES-'
-      /%%Page:/{
-	N
-	/%%BeginPageSetup/b again
-      }
-      b
-    :again
-      /%%EndPageSetup/b finish
-      /%%Page:/{
-	N
-	b again
-      }
-      b
-    :finish
-      N
-      /^%%Page:.*\n0 Cg EP$/d
-    '} $TC_DATA $BD_DATA | $PDFROFF_POSTPROCESSOR_COMMAND $CS_DATA -
+  if test -n "$TC_FILTER$BD_FILTER"
+  then ${PDFROFF_COLLATE-"$SED"} ${PDFROFF_KILL_NULL_PAGES-'
+	 /%%Page:/{
+	   N
+	   /%%BeginPageSetup/b again
+	 }
+	 b
+       :again
+	 /%%EndPageSetup/b finish
+	 /%%Page:/{
+	   N
+	   b again
+	 }
+	 b
+       :finish
+	 N
+	 /^%%Page:.*\n0 Cg EP$/d
+       '} $TC_FILTER $BD_FILTER
+  fi | $PDFROFF_POSTPROCESSOR_COMMAND $CS_DATA $TC_DATA $BD_DATA
   $SAY >&2 ". done"
 #
 # ------------------------------------------------------------------------------

diff -r 7fed1c1a83d2 -r ecd113b7c40f tmac/spdf.tmac
--- a/tmac/spdf.tmac	Wed Mar 29 18:59:09 2023 +0100
+++ b/tmac/spdf.tmac	Fri Mar 31 14:41:10 2023 +0100
@@ -271,6 +271,7 @@
 .\" the TOC output phase of document production.
 .\"
 .de TC
+.   if d pdfroff .if \\n[PHASE]>1 .return
 .   pdfsync O
 .   P1
 .   OP \n[PDF-TOC-ONLY]