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

docs and minor tweaks...

Browse Source 
Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2021-11-18 16:49:24 +03:00
parent d7c27f2897
commit 2faafc2509
2 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Makefile
View File

@ -40,6 +40,7 @@ DOC := ./scripts/cls2tex.sh
# NOTE: .sty and .cls are essentially the same in terms of documentation # NOTE: .sty and .cls are essentially the same in terms of documentation
# generation... # generation...
# XXX should these depend on $(DOC) ???
%.tex: %.sty %-meta.tex %.tex: %.sty %-meta.tex
$(DOC) $< $@ $(DOC) $< $@

16
scripts/cls2tex.sh
View File

@ -12,6 +12,15 @@ printhelp(){
echo " - %%%% Text -> \\section(Text)" echo " - %%%% Text -> \\section(Text)"
echo " - %% >> code -> \\begin{verbatim}code\\end{verbatim}" echo " - %% >> code -> \\begin{verbatim}code\\end{verbatim}"
echo echo
echo "PREFIX can replace the second \"%\" in the above patterns to make it"
echo "possible to integrate multiple layers of documentation in one file"
echo "and to integrate them in various ways, for example, in the photobook"
echo "document class documentation \"M\" prefix is used to indicate"
echo "meta-command docs, this enables us to document them in the relevant"
echo "location (i.e. at the implementation) in source but move the docs to"
echo "a unified location in docs, effectively decoupling the source and doc"
echo "structure when needed."
echo
echo "NOTE: the idea of keeping latex docs in a latex file is far simpler" 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 " than all the stuff crammed into .dtx, at least for my needs:"
echo " - keep the code readable" echo " - keep the code readable"
@ -42,11 +51,14 @@ if [ -z $PREFIX ] ; then
PREFIX=% PREFIX=%
fi fi
# generate the module name...
MODULE=$(basename "$INPUT")
MODULE=${MODULE/.*/}
# do the work... # do the work...
cat "$INPUT" \ cat "$INPUT" \
| egrep '(^%'$PREFIX'|^\\edef\\.*@[A-Z][A-Z]+)' \ | egrep '(^%'$PREFIX'|^\\edef\\'$MODULE'@[A-Z][A-Z]+)' \
| sed 's/^\(\\edef\\\).*@/%'$PREFIX'\1/' \ | sed 's/^\(\\edef\\\)'$MODULE'@/%'$PREFIX'\1/' \
| sed 's/%'$PREFIX'%%%% \(.*\)/%'$PREFIX'\\subsubsection{\1}\\label{subsubsec:\1}/' \ | sed 's/%'$PREFIX'%%%% \(.*\)/%'$PREFIX'\\subsubsection{\1}\\label{subsubsec:\1}/' \
| sed 's/%'$PREFIX'%%% \(.*\)/%'$PREFIX'\\subsection{\1}\\label{subsec:\1}/' \ | sed 's/%'$PREFIX'%%% \(.*\)/%'$PREFIX'\\subsection{\1}\\label{subsec:\1}/' \
| sed 's/%'$PREFIX'%% \(.*\)/%'$PREFIX'\\section{\1}\\label{sec:\1}/' \ | sed 's/%'$PREFIX'%% \(.*\)/%'$PREFIX'\\section{\1}\\label{sec:\1}/' \