flynx/photobook
1
0
Fork 0
mirror of https://github.com/flynx/photobook.git synced 2025-10-28 18:00:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

cleanup and docs...

Browse Source 
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2021-11-16 00:58:45 +03:00
parent 919f02fb3d
commit f4ceb108e6
3 changed files with 37 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -22,7 +22,7 @@ SHELL := bash
# LaTeX...
ARGS :=
# NOTE: need to run latex two times to build index, the simpler way to
# NOTE: need to run latex two+ times to build index, the simpler way to
# go is to use latexmk...
#TEX := lualatex $(ARGS)
TEX := latexmk -lualatex $(ARGS)

2
photobook.cls
View File

@ -691,7 +691,7 @@
\newlength\bindingoffset
\setlength\bindingoffset{\photobook@bindingoffset}
%% \DescribeMacro{\defaultfoldout=<fold-spce>}
%% \DescribeMacro{\defaultfoldout=<fold-spec>}
%
%% Set the default fold specification.
%%

53
scripts/cls2tex.sh
View File

@ -1,22 +1,37 @@
#!/usr/bin/env bash
# Generate docs from latex package/class...
#
# Usage: cls2tex.sh INPUT OUTPUT [PREFIX]
#
# - keep lines starting with \def\<module-name>@[A-Z]\+
# - keep lines starting with '%%'
# - %%%%% Text -> \subsection(Text)
# - %%%% Text -> \section(Text)
# - %% >> code -> \begin{verbatim}code\end{verbatim}
#
# NOTE: the idea of keeping latex docs in a latex file is far similar
# than all the stuff crammed into .dtx, at least for my needs:
# - keep the code readable
# - keep the docs readable
# in both the repo and in installed form.
# NOTE: this is evolving as need arises, when this gets too complicated
# we'll split it out into it's own script.
printhelp(){
echo "Generate docs from latex package/class"
echo
echo "Usage: $(basename $0) [-h] INPUT OUTPUT [PREFIX]"
echo
echo "This will:"
echo " - keep lines starting with \\def\\<module-name>@[A-Z]\\+"
echo " - keep lines starting with '%%'"
echo " - %%%%% Text -> \\subsection(Text)"
echo " - %%%% Text -> \\section(Text)"
echo " - %% >> code -> \\begin{verbatim}code\\end{verbatim}"
echo
echo "NOTE: the idea of keeping latex docs in a latex file is far simpler"
echo " than all the stuff crammed into .dtx, at least for my needs:"
echo " - keep the code readable"
echo " - keep the docs readable"
echo " in both the repo and in installed form, so .dtx is not used."
}
# args/defaults...
while true ; do
case $1 in
-h|--help)
printhelp
exit
;;
*)
break
;;
esac
done
INPUT=$1
@ -28,6 +43,7 @@ if [ -z $PREFIX ] ; then
fi
# do the work...
cat "$INPUT" \
| egrep '(^%'$PREFIX'|^\\edef\\.*@[A-Z][A-Z]+)' \
| sed 's/^\(\\edef\\\).*@/%'$PREFIX'\1/' \
@ -35,7 +51,8 @@ cat "$INPUT" \
| sed 's/%'$PREFIX'%%% \(.*\)/%'$PREFIX'\\subsection{\1}\\label{subsec:\1}/' \
| sed 's/%'$PREFIX'%% \(.*\)/%'$PREFIX'\\section{\1}\\label{sec:\1}/' \
| sed 's/%'$PREFIX'\s\+>>\s\+\(.*\)/%'$PREFIX'\\begin{verbatim} \1 \\end{verbatim}/' \
| cut -c 3- - > "$OUTPUT"
| cut -c 3- - \
> "$OUTPUT"
# vim:set ts=4 sw=4 nowrap :