--- /srv/reproducible-results/rbuild-debian/r-b-build.VNBOmsOo/b1/htp_1.19-8_amd64.changes +++ /srv/reproducible-results/rbuild-debian/r-b-build.VNBOmsOo/b2/htp_1.19-8_amd64.changes ├── Files │ @@ -1,3 +1,3 @@ │ │ 1dad186844b621499093fc4d88e03b24 70884 debug optional htp-dbgsym_1.19-8_amd64.deb │ - 207d3fe30d66b8e20ff70dfbdafd86e8 116020 web optional htp_1.19-8_amd64.deb │ + e38628d656dc87e05694bcc24d7199fc 116920 web optional htp_1.19-8_amd64.deb ├── htp_1.19-8_amd64.deb │ ├── file list │ │ @@ -1,3 +1,3 @@ │ │ -rw-r--r-- 0 0 0 4 2020-06-14 23:21:19.000000 debian-binary │ │ --rw-r--r-- 0 0 0 3612 2020-06-14 23:21:19.000000 control.tar.xz │ │ --rw-r--r-- 0 0 0 112216 2020-06-14 23:21:19.000000 data.tar.xz │ │ +-rw-r--r-- 0 0 0 3616 2020-06-14 23:21:19.000000 control.tar.xz │ │ +-rw-r--r-- 0 0 0 113112 2020-06-14 23:21:19.000000 data.tar.xz │ ├── control.tar.xz │ │ ├── control.tar │ │ │ ├── ./control │ │ │ │ @@ -1,12 +1,12 @@ │ │ │ │ Package: htp │ │ │ │ Version: 1.19-8 │ │ │ │ Architecture: amd64 │ │ │ │ Maintainer: Marcelo Soares Mota │ │ │ │ -Installed-Size: 621 │ │ │ │ +Installed-Size: 641 │ │ │ │ Depends: libc6 (>= 2.34) │ │ │ │ Section: web │ │ │ │ Priority: optional │ │ │ │ Homepage: http://htp.sourceforge.net │ │ │ │ Description: nice HTML pre-processor │ │ │ │ htp is an HTML pre-processor. It is designed to be a flexible authoring tool │ │ │ │ that can easily be integrated into the HTML design process. │ │ │ ├── ./md5sums │ │ │ │ ├── ./md5sums │ │ │ │ │┄ Files differ │ ├── data.tar.xz │ │ ├── data.tar │ │ │ ├── file list │ │ │ │ @@ -1,27 +1,27 @@ │ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2020-06-14 23:21:19.000000 ./ │ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2020-06-14 23:21:19.000000 ./usr/ │ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2020-06-14 23:21:19.000000 ./usr/bin/ │ │ │ │ -rwxr-xr-x 0 root (0) root (0) 72104 2020-06-14 23:21:19.000000 ./usr/bin/htp │ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2020-06-14 23:21:19.000000 ./usr/share/ │ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2020-06-14 23:21:19.000000 ./usr/share/doc/ │ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/ │ │ │ │ --rw-r--r-- 0 root (0) root (0) 9593 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/alttext.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 8180 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/alttext.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 1418 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/alttext.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 7882 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/block.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 781 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/block.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 7941 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/blockdef.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 1075 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/blockdef.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 4763 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/bugs.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 737 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/bugs.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 878 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/changelog.Debian.gz │ │ │ │ -rw-r--r-- 0 root (0) root (0) 7719 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/comment.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 676 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/comment.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 13083 2020-06-14 23:16:46.000000 ./usr/share/doc/htp/copyright │ │ │ │ --rw-r--r-- 0 root (0) root (0) 9953 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/def.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 14391 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/def.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 3601 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/def.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 8030 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/default.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 3149 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/default.htp │ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/examples/ │ │ │ │ -rw-r--r-- 0 root (0) root (0) 536 2015-05-16 17:04:11.000000 ./usr/share/doc/htp/examples/Makefile.sub │ │ │ │ -rw-r--r-- 0 root (0) root (0) 2404 2015-05-16 17:04:11.000000 ./usr/share/doc/htp/examples/album.hti │ │ │ │ -rw-r--r-- 0 root (0) root (0) 1087 2015-05-16 17:04:11.000000 ./usr/share/doc/htp/examples/album.htt │ │ │ │ @@ -32,43 +32,43 @@ │ │ │ │ -rw-r--r-- 0 root (0) root (0) 818 2015-05-16 17:04:11.000000 ./usr/share/doc/htp/examples/prime.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 1576 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/examples/quine.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 1576 2015-05-16 17:04:11.000000 ./usr/share/doc/htp/examples/quine.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 604 2015-05-16 17:04:11.000000 ./usr/share/doc/htp/examples/section.def │ │ │ │ -rw-r--r-- 0 root (0) root (0) 1189 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/examples/section.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 918 2015-05-16 17:04:11.000000 ./usr/share/doc/htp/examples/section.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 375 2015-05-16 17:04:11.000000 ./usr/share/doc/htp/examples/section.htt │ │ │ │ --rw-r--r-- 0 root (0) root (0) 7909 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/expand.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 9468 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/expand.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 3702 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/expand.htp │ │ │ │ --rw-r--r-- 0 root (0) root (0) 14458 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/file.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 17552 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/file.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 2490 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/file.htp.gz │ │ │ │ -rw-r--r-- 0 root (0) root (0) 14293 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/history.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 3946 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/history.htp.gz │ │ │ │ -rw-r--r-- 0 root (0) root (0) 3911 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/hlhtp.pl │ │ │ │ -rw-r--r-- 0 root (0) root (0) 165 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/htp.def │ │ │ │ -rw-r--r-- 0 root (0) root (0) 4049 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/htp.htt │ │ │ │ --rw-r--r-- 0 root (0) root (0) 8198 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/if.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 8434 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/if.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 932 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/if.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 8626 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/imageurl.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 2507 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/imageurl.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 8277 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/img.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 1168 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/img.htp │ │ │ │ --rw-r--r-- 0 root (0) root (0) 8142 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/inc.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 9216 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/inc.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 1092 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/inc.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 9881 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/include.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 1894 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/include.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 4874 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/index.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 78 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/index.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 7733 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/intro.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 3489 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/intro.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 10774 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/license.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 454 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/license.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 3782 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/macros.def │ │ │ │ -rw-r--r-- 0 root (0) root (0) 5088 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/macros.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 388 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/macros.htp │ │ │ │ --rw-r--r-- 0 root (0) root (0) 12505 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/metatag.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 13190 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/metatag.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 2439 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/metatag.htp.gz │ │ │ │ -rw-r--r-- 0 root (0) root (0) 7558 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/opt.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 608 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/opt.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 7809 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/options.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 3100 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/options.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 7777 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/output.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 695 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/output.htp │ │ │ │ @@ -79,17 +79,17 @@ │ │ │ │ -rw-r--r-- 0 root (0) root (0) 25563 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/pic/logo.png │ │ │ │ -rw-r--r-- 0 root (0) root (0) 455 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/pic/manbig.png │ │ │ │ -rw-r--r-- 0 root (0) root (0) 491 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/pic/manual.png │ │ │ │ -rw-r--r-- 0 root (0) root (0) 1313 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/pic/poweredbyhtp.png │ │ │ │ -rw-r--r-- 0 root (0) root (0) 679 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/pic/sficon.png │ │ │ │ -rw-r--r-- 0 root (0) root (0) 492 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/pic/source.png │ │ │ │ -rw-r--r-- 0 root (0) root (0) 523 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/pphtp.pl │ │ │ │ --rw-r--r-- 0 root (0) root (0) 7503 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/quote.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 8569 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/quote.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 390 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/quote.htp │ │ │ │ --rw-r--r-- 0 root (0) root (0) 8234 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/set.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 13562 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/set.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 1200 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/set.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 500 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/styles.css │ │ │ │ -rw-r--r-- 0 root (0) root (0) 27219 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/template.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 2235 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/template.htp.gz │ │ │ │ -rw-r--r-- 0 root (0) root (0) 1914 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/toc.def │ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/tut/ │ │ │ │ -rw-r--r-- 0 root (0) root (0) 146 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/tut/footer.hti │ │ │ │ @@ -102,23 +102,23 @@ │ │ │ │ -rw-r--r-- 0 root (0) root (0) 192 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/tut/tut2.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 501 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/tut/tut3.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 191 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/tut/tut3.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 356 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/tut/tut3.htt │ │ │ │ -rw-r--r-- 0 root (0) root (0) 297 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/tut/tut4.htt │ │ │ │ -rw-r--r-- 0 root (0) root (0) 10517 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/tutorial.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 3393 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/tutorial.htp │ │ │ │ --rw-r--r-- 0 root (0) root (0) 7559 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/undef.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 7804 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/undef.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 460 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/undef.htp │ │ │ │ --rw-r--r-- 0 root (0) root (0) 8310 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/unset.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 8802 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/unset.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 658 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/unset.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 7681 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/usage.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 2959 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/usage.htp │ │ │ │ --rw-r--r-- 0 root (0) root (0) 12007 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/use.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 17527 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/use.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 3300 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/use.htp │ │ │ │ --rw-r--r-- 0 root (0) root (0) 9561 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/while.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 8976 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/while.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 938 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/while.htp │ │ │ │ -rw-r--r-- 0 root (0) root (0) 5288 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/wishlist.html │ │ │ │ -rw-r--r-- 0 root (0) root (0) 1311 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/wishlist.htp │ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2020-06-14 23:21:19.000000 ./usr/share/doc-base/ │ │ │ │ -rw-r--r-- 0 root (0) root (0) 235 2020-06-14 17:36:12.000000 ./usr/share/doc-base/htp.htp │ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2020-06-14 23:21:19.000000 ./usr/share/lintian/ │ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2020-06-14 23:21:19.000000 ./usr/share/lintian/overrides/ │ │ │ ├── ./usr/share/doc/htp/alttext.html │ │ │ │ @@ -127,22 +127,14 @@ │ │ │ │

│ │ │ │ When an IMG tag with a matching source is encountered, htp will add an ALT │ │ │ │ attribute only if one is not already present. This allows for ALT text to │ │ │ │ be overridden on specific images and default text on all others. │ │ │ │

│ │ │ │ For example: │ │ │ │

│ │ │ │ -<[ref]OPT (IMGXY|NOIMGXY)>
│ │ │ │ -<[ref]OPT (QUIET|VERBOSE)>
│ │ │ │ -<[ref]OPT (DEPEND|NODEPEND)>
│ │ │ │ -<[ref]OPT (PRECIOUS|NOPRECIOUS)>
│ │ │ │ -<[ref]OPT (CONDENSE|SEMICONDENSE|NOCONDENSE)>
│ │ │ │ -<[ref]OPT DELIM=(HTML|SQUARE|CURLY)>
│ │ │ │ -<[ref]OPT (XML|XML=FALSE)>
│ │ │ │ -
│ │ │ │

│ │ │ │

│ │ │ │ An ALTTEXT tag with a name but no text attribute removes any ALT │ │ │ │ mapping for this image. Successing IMG tags with a matching SRC name are not │ │ │ │ changed. │ │ │ │

│ │ │ │ Since this is useful for an image used throughout a set of documents, │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -9,36 +9,28 @@ │ │ │ │ │   [>] _A_L_T_T_E_X_T comparisons. │ │ │ │ │     _B_L_O_C_K When an IMG tag with a matching source is │ │ │ │ │     _B_L_O_C_K_D_E_F encountered, htp will add an ALT attribute only if │ │ │ │ │     _D_E_F one is not already present. This allows for ALT │ │ │ │ │     _F_I_L_E text to be overridden on specific images and │ │ │ │ │     _I_F default text on all others. │ │ │ │ │     _I_N_C For example: │ │ │ │ │ -    _I_M_G <_[_[_r_e_f_]_]_O_P_T (IMGXY|NOIMGXY)> │ │ │ │ │ -    _I_M_A_G_E_U_R_L <_[_[_r_e_f_]_]_O_P_T (QUIET|VERBOSE)> │ │ │ │ │ -    _O_P_T <_[_[_r_e_f_]_]_O_P_T (DEPEND|NODEPEND)> │ │ │ │ │ -    _O_U_T_P_U_T <_[_[_r_e_f_]_]_O_P_T (PRECIOUS|NOPRECIOUS)> │ │ │ │ │ -    _Q_U_O_T_E <_[_[_r_e_f_]_]_O_P_T (CONDENSE|SEMICONDENSE|NOCONDENSE)> │ │ │ │ │ -    _S_E_T <_[_[_r_e_f_]_]_O_P_T DELIM=(HTML|SQUARE|CURLY)> │ │ │ │ │ -    _U_N_D_E_F <_[_[_r_e_f_]_]_O_P_T (XML|XML=FALSE)> │ │ │ │ │ -    _U_N_S_E_T │ │ │ │ │ -    _U_S_E_,_ _$ An ALTTEXT tag with a name but no text attribute │ │ │ │ │ -    _W_H_I_L_E removes any ALT mapping for this image. Successing │ │ │ │ │ -    _<_!_-_-_- IMG tags with a matching SRC name are not changed. │ │ │ │ │ -  _H_i_s_t_o_r_y Since this is useful for an image used throughout a │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t set of documents, ALTTEXT is most appropriate in an │ │ │ │ │ -  _B_u_g_s _i_n_c_l_u_d_e_ _f_i_l_e or a _d_e_f_a_u_l_t_ _f_i_l_e. │ │ │ │ │ - In addition to ALTTEXT, htp can also automatically │ │ │ │ │ - add WIDTH and HEIGHT attributes to _I_M_G tags. │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ +    _I_M_G An ALTTEXT tag with a name but no text attribute │ │ │ │ │ +    _I_M_A_G_E_U_R_L removes any ALT mapping for this image. Successing │ │ │ │ │ +    _O_P_T IMG tags with a matching SRC name are not changed. │ │ │ │ │ +    _O_U_T_P_U_T Since this is useful for an image used throughout a │ │ │ │ │ +    _Q_U_O_T_E set of documents, ALTTEXT is most appropriate in an │ │ │ │ │ +    _S_E_T _i_n_c_l_u_d_e_ _f_i_l_e or a _d_e_f_a_u_l_t_ _f_i_l_e. │ │ │ │ │ +    _U_N_D_E_F In addition to ALTTEXT, htp can also automatically │ │ │ │ │ +    _U_N_S_E_T add WIDTH and HEIGHT attributes to _I_M_G tags. │ │ │ │ │ +    _U_S_E_,_ _$ │ │ │ │ │ +    _W_H_I_L_E │ │ │ │ │ +    _<_!_-_-_- │ │ │ │ │ +  _H_i_s_t_o_r_y │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t │ │ │ │ │ +  _B_u_g_s │ │ │ ├── ./usr/share/doc/htp/def.html │ │ │ │ @@ -114,14 +114,32 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ +  <[ref]blockdef name="section" option="title">
│ │ │ │ +   <h1><[ref]use title></h1>
│ │ │ │ +   <p class="section">
│ │ │ │ +     <[ref]use block>
│ │ │ │ +   </p>
│ │ │ │ +  <[ref]/blockdef>
│ │ │ │ +
│ │ │ │ +  <section title="My Section">
│ │ │ │ +    This is a fancy section.
│ │ │ │ +  </section>
│ │ │ │ +mg src="rightsep.png"></td>
│ │ │ │ +   </tr>
│ │ │ │ +   </table>
│ │ │ │ + <[ref]/def>
│ │ │ │ +
│ │ │ │ + paragraph
│ │ │ │ + <imghr>
│ │ │ │ + paragraph
│ │ │ │

│ │ │ │

synopsis

│ │ │ │

│ │ │ │ DEF creates metatags, which is a │ │ │ │ fancy way of saying it creates new tags. The mechanism is very similar to │ │ │ │ BLOCK macros, except that the USE │ │ │ │ tag is not used to expand them. Instead, they are expanded by their own name. │ │ │ │ @@ -133,24 +151,36 @@ │ │ │ │ Some metatags will require an opening and closing tag (comparable to │ │ │ │ and ). In this case, you should use the BLOCKDEF macro. Another slightly faster │ │ │ │ alternative is to use two metatags, the opening tag and the closing │ │ │ │ tag with a preceding slash. For example: │ │ │ │

│ │ │ │

│ │ │ │ +  <[ref]def name="sharedimg" option="name alt">
│ │ │ │ +    <[ref]img src="/home/sharedimages/${name}" alt="${alt}">;
│ │ │ │ +  <[ref]/def>
│ │ │ │ +
│ │ │ │ +  <sharedimg name="bubble.gif" alt="Bubble image">
│ │ │ │

│ │ │ │

You should really use BLOCKDEF, though, │ │ │ │ as it will check for matching end tag. It is not that slower.

│ │ │ │

│ │ │ │ Options can be passed to a metatag, which can then expand as if it were │ │ │ │ a SET macro. Option names are parameterized with │ │ │ │ the OPTION attribute. Multiple options can be listed by separating their │ │ │ │ name with a space (which therefore requires they be surrounded by quotes.) │ │ │ │

│ │ │ │

│ │ │ │ +  <[ref]set sect-ctr="0">
│ │ │ │ +  <[ref]blockdef name="section">
│ │ │ │ +    <[ref]inc sect-ctr>
│ │ │ │ +    <[ref]block name="sect-${sect-ctr}" expand global>
│ │ │ │ +      <[ref]use block noexpand>
│ │ │ │ +    <[ref]/block>
│ │ │ │ +  <[ref]/blockdef>
│ │ │ │

│ │ │ │

│ │ │ │ htp will do very specific checking of parameters when a metatag is │ │ │ │ invoked. htp assumes that all parameter options to the metatag are │ │ │ │ optional. This is why the HEADERIMG definition uses IF to verify the │ │ │ │ SIZE option is defined before expanding it in the block. If a │ │ │ │ parameter is required, simply expand it without first checking. When │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,36 +1,68 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: DDEEFF,, //DDEEFF ************ │ │ │ │ │ _T_a_b_l_e_ _o_f_ _C_o_n_t_e_n_t_s ********** ssyynnttaaxx ********** │ │ │ │ │ -  _I_n_t_r_o_d_u_c_t_i_o_n ********** ssyynnooppssiiss ********** │ │ │ │ │ -  _L_i_c_e_n_s_e DDEEFF creates _m_e_t_a_t_a_g_s, which is a fancy way of │ │ │ │ │ -  _T_u_t_o_r_i_a_l saying it creates new tags. The mechanism is very │ │ │ │ │ -  _U_s_a_g_e similar to _B_L_O_C_K macros, except that the _U_S_E tag is │ │ │ │ │ -  HTP Tags not used to expand them. Instead, they are expanded │ │ │ │ │ -    _A_L_T_T_E_X_T by their own name. For example: │ │ │ │ │ -    _B_L_O_C_K Some metatags will require an opening and closing │ │ │ │ │ -    _B_L_O_C_K_D_E_F tag (comparable to │ │ │ │ │ -  [>] _D_E_F and │ │ │ │ │ -    _F_I_L_E ). In this case, you should use the _B_L_O_C_K_D_E_F macro. │ │ │ │ │ -    _I_F Another slightly faster alternative is to use two │ │ │ │ │ -    _I_N_C metatags, the opening tag and the closing tag with │ │ │ │ │ -    _I_M_G a preceding slash. For example: │ │ │ │ │ -    _I_M_A_G_E_U_R_L You should really use _B_L_O_C_K_D_E_F, though, as it will │ │ │ │ │ -    _O_P_T check for matching end tag. It is not that slower. │ │ │ │ │ -    _O_U_T_P_U_T Options can be passed to a metatag, which can then │ │ │ │ │ -    _Q_U_O_T_E expand as if it were a _S_E_T macro. Option names are │ │ │ │ │ -    _S_E_T parameterized with the OPTION attribute. Multiple │ │ │ │ │ -    _U_N_D_E_F options can be listed by separating their name with │ │ │ │ │ -    _U_N_S_E_T a space (which therefore requires they be │ │ │ │ │ -    _U_S_E_,_ _$ surrounded by quotes.) │ │ │ │ │ -    _W_H_I_L_E htp will do very specific checking of parameters │ │ │ │ │ -    _<_!_-_-_- when a metatag is invoked. htp assumes that all │ │ │ │ │ -  _H_i_s_t_o_r_y parameter options to the metatag are optional. This │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t is why the HEADERIMG definition uses IF to verify │ │ │ │ │ -  _B_u_g_s the SIZE option is defined before expanding it in │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n   <_[_[_r_e_f_]_]_b_l_o_c_k_d_e_f name="section" option="title"> │ │ │ │ │ +  _L_i_c_e_n_s_e    

<_[_[_r_e_f_]_]_u_s_e title>

│ │ │ │ │ +  _T_u_t_o_r_i_a_l    

│ │ │ │ │ +  _U_s_a_g_e      <_[_[_r_e_f_]_]_u_s_e block> │ │ │ │ │ +  HTP Tags    

│ │ │ │ │ +    _A_L_T_T_E_X_T   <_[_[_r_e_f_]_]_/_b_l_o_c_k_d_e_f> │ │ │ │ │ +    _B_L_O_C_K │ │ │ │ │ +    _B_L_O_C_K_D_E_F  
│ │ │ │ │ +  [>] _D_E_F     This is a fancy section. │ │ │ │ │ +    _F_I_L_E  
│ │ │ │ │ +    _I_F mg src="rightsep.png"> │ │ │ │ │ +    _I_N_C     │ │ │ │ │ +    _I_M_G     │ │ │ │ │ +    _I_M_A_G_E_U_R_L  <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ +    _O_P_T │ │ │ │ │ +    _O_U_T_P_U_T  paragraph │ │ │ │ │ +    _Q_U_O_T_E   │ │ │ │ │ +    _S_E_T  paragraph │ │ │ │ │ +    _U_N_D_E_F ********** ssyynnooppssiiss ********** │ │ │ │ │ +    _U_N_S_E_T DDEEFF creates _m_e_t_a_t_a_g_s, which is a fancy way of │ │ │ │ │ +    _U_S_E_,_ _$ saying it creates new tags. The mechanism is very │ │ │ │ │ +    _W_H_I_L_E similar to _B_L_O_C_K macros, except that the _U_S_E tag is │ │ │ │ │ +    _<_!_-_-_- not used to expand them. Instead, they are expanded │ │ │ │ │ +  _H_i_s_t_o_r_y by their own name. For example: │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t Some metatags will require an opening and closing │ │ │ │ │ +  _B_u_g_s tag (comparable to │ │ │ │ │ + and │ │ │ │ │ + ). In this case, you should use the _B_L_O_C_K_D_E_F macro. │ │ │ │ │ + Another slightly faster alternative is to use two │ │ │ │ │ + metatags, the opening tag and the closing tag with │ │ │ │ │ + a preceding slash. For example: │ │ │ │ │ +   <_[_[_r_e_f_]_]_d_e_f name="sharedimg" option="name alt"> │ │ │ │ │ +     <_[_[_r_e_f_]_]_i_m_g src="/home/sharedimages/${name}" │ │ │ │ │ + alt="${alt}">; │ │ │ │ │ +   <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ + │ │ │ │ │ +   │ │ │ │ │ + You should really use _B_L_O_C_K_D_E_F, though, as it will │ │ │ │ │ + check for matching end tag. It is not that slower. │ │ │ │ │ + Options can be passed to a metatag, which can then │ │ │ │ │ + expand as if it were a _S_E_T macro. Option names are │ │ │ │ │ + parameterized with the OPTION attribute. Multiple │ │ │ │ │ + options can be listed by separating their name with │ │ │ │ │ + a space (which therefore requires they be │ │ │ │ │ + surrounded by quotes.) │ │ │ │ │ +   <_[_[_r_e_f_]_]_s_e_t sect-ctr="0"> │ │ │ │ │ +   <_[_[_r_e_f_]_]_b_l_o_c_k_d_e_f name="section"> │ │ │ │ │ +     <_[_[_r_e_f_]_]_i_n_c sect-ctr> │ │ │ │ │ +     <_[_[_r_e_f_]_]_b_l_o_c_k name="sect-${sect-ctr}" expand │ │ │ │ │ + global> │ │ │ │ │ +       <_[_[_r_e_f_]_]_u_s_e block noexpand> │ │ │ │ │ +     <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ +   <_[_[_r_e_f_]_]_/_b_l_o_c_k_d_e_f> │ │ │ │ │ + htp will do very specific checking of parameters │ │ │ │ │ + when a metatag is invoked. htp assumes that all │ │ │ │ │ + parameter options to the metatag are optional. This │ │ │ │ │ + is why the HEADERIMG definition uses IF to verify │ │ │ │ │ + the SIZE option is defined before expanding it in │ │ │ │ │ the block. If a parameter is required, simply │ │ │ │ │ expand it without first checking. When htp expands │ │ │ │ │ the metatag and the macro is not defined, it will │ │ │ │ │ halt processing and complain with an error message │ │ │ │ │ and the required macro name. Normally htp will not │ │ │ │ │ allow parameters not listed in the OPTION attribute │ │ │ │ │ to be added to the tag. This is why the third │ │ │ ├── ./usr/share/doc/htp/expand.html │ │ │ │ @@ -101,14 +101,23 @@ │ │ │ │ another macro. This other macro may no longer have the correct value │ │ │ │ when the macro is expanded. Here is some code that demonstrate when │ │ │ │ the htp tags are expanded:

│ │ │ │

│ │ │ │

│ │ │ │ This produces the following: │ │ │ │

│ │ │ │ +<[ref]block stuff>
│ │ │ │ +  <a href=$email>send email</a>
│ │ │ │ +<[ref]/block>
│ │ │ │ +
│ │ │ │ +<[ref]set morestuff=$email>
│ │ │ │ +
│ │ │ │ +This works:     <[ref]use stuff email="jnelson@crl.com">
│ │ │ │ +But this fails: <[ref]use email>
│ │ │ │ +And this fails: <[ref]use morestuff email="jnelson@crl.com">
│ │ │ │

│ │ │ │

│ │ │ │ When block a and block b are defined in lines 2-7 the contents of a │ │ │ │ are taken literally, however, the contents for b are already expanded │ │ │ │ so the macro time is evaluated. So a is expanded when it │ │ │ │ is used, while the contents of b are already expanded. │ │ │ │

│ │ │ │ ├── html2text {} │ │ │ │ │ @@ -25,14 +25,25 @@ │ │ │ │ │ modifier it is expanded immediately. This is useful │ │ │ │ │ if you want to store something in a block macro, │ │ │ │ │ that depends on the current value of another macro. │ │ │ │ │ This other macro may no longer have the correct │ │ │ │ │ value when the macro is expanded. Here is some code │ │ │ │ │ that demonstrate when the htp tags are expanded: │ │ │ │ │ This produces the following: │ │ │ │ │ + <_[_[_r_e_f_]_]_b_l_o_c_k stuff> │ │ │ │ │ +   send email │ │ │ │ │ + <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ + │ │ │ │ │ + <_[_[_r_e_f_]_]_s_e_t morestuff=$email> │ │ │ │ │ + │ │ │ │ │ + This works:     <_[_[_r_e_f_]_]_u_s_e stuff │ │ │ │ │ + email="jnelson@crl.com"> │ │ │ │ │ + But this fails: <_[_[_r_e_f_]_]_u_s_e email> │ │ │ │ │ + And this fails: <_[_[_r_e_f_]_]_u_s_e morestuff │ │ │ │ │ + email="jnelson@crl.com"> │ │ │ │ │ When block a and block b are defined in lines 2- │ │ │ │ │ 7 the contents of a are taken literally, however, │ │ │ │ │ the contents for b are already expanded so the │ │ │ │ │ macro time is evaluated. So a is expanded when it │ │ │ │ │ is used, while the contents of b are already │ │ │ │ │ expanded. │ │ │ │ │ In line 10 and 12 the _[_[_r_e_f_]_]_u_s_e tag is used with │ │ │ ├── ./usr/share/doc/htp/file.html │ │ │ │ @@ -114,22 +114,14 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ -<[ref]OPT (IMGXY|NOIMGXY)>
│ │ │ │ -<[ref]OPT (QUIET|VERBOSE)>
│ │ │ │ -<[ref]OPT (DEPEND|NODEPEND)>
│ │ │ │ -<[ref]OPT (PRECIOUS|NOPRECIOUS)>
│ │ │ │ -<[ref]OPT (CONDENSE|SEMICONDENSE|NOCONDENSE)>
│ │ │ │ -<[ref]OPT DELIM=(HTML|SQUARE|CURLY)>
│ │ │ │ -<[ref]OPT (XML|XML=FALSE)>
│ │ │ │ -
│ │ │ │

│ │ │ │

synopsis

│ │ │ │ FILE has several optional parameters of differing purpose. │ │ │ │ The output file's name, the current date and time, and the contents of │ │ │ │ another file may be included. Another file's time, date, or size may be │ │ │ │ added to the output file as well. │ │ │ │

│ │ │ │ @@ -140,14 +132,38 @@ │ │ │ │

│ │ │ │

NAME, TIME, SIZE

│ │ │ │

│ │ │ │ To include information about another file, such as an archive file or │ │ │ │ graphic image, specify its name with the NAME attribute followed by the │ │ │ │ type of information to be displayed: │ │ │ │

│ │ │ │ +  <[ref]DEF NAME="HEADERIMG" OPTION="SRC TITLE SIZE">
│ │ │ │ +    <[ref]IF size>
│ │ │ │ +        <FONT SIZE=${size}>
│ │ │ │ +    <[ref]/IF>
│ │ │ │ +    <[ref]IMG SRC=pics/${src}>
│ │ │ │ +    <[ref]USE title>
│ │ │ │ +    <[ref]IF size>
│ │ │ │ +        </FONT>
│ │ │ │ +    <[ref]/IF>
│ │ │ │ +  <[ref]/DEF>
│ │ │ │ +
│ │ │ │ +  <HEADERIMG SRC="logo.gif" SIZE="+2" TITLE="A title">
│ │ │ │ +
│ │ │ │ +  <HEADERIMG SRC="logo.gif" TITLE="Normal sized title">
│ │ │ │ +
│ │ │ │ +  This will fail:
│ │ │ │ +  <HEADERIMG SRC="logo.gif" ALT="Our logo" TITLE="Another title">
│ │ │ │ +
│ │ │ │ +  Instead, use * like this:
│ │ │ │ +  <[ref]DEF NAME="MYIMG" OPTION="SRC *">
│ │ │ │ +    <[ref]IMG SRC="pics/${src}" $*>
│ │ │ │ +  <[ref]/DEF>
│ │ │ │ +   
│ │ │ │ +  <MYIMG SRC="logo.gif" ALT="Our logo">
│ │ │ │

│ │ │ │

│ │ │ │ For file size information, the value BYTE, KBYTE, etc. dictates how the │ │ │ │ information is displayed. In anything other than byte format, the information │ │ │ │ is displayed in floating-point notation. The amount of precision (the number │ │ │ │ of digits to the right of the decimal point) can be set with the optional │ │ │ │ PRECISION attribute. The default precision is zero (0), which means no │ │ │ │ @@ -176,14 +192,21 @@ │ │ │ │

│ │ │ │ Additional parameters can be set in the FILE INCLUDE tag, which are │ │ │ │ interpreted as macros that are "passed" to the included file. The macros │ │ │ │ are available only to the include file (and any macros or included files it │ │ │ │ holds). After the file is completely included, the macros are no longer │ │ │ │ available. So: │ │ │ │

│ │ │ │ +  <[ref]set sect-ctr="0">
│ │ │ │ +  <[ref]blockdef name="section">
│ │ │ │ +    <[ref]inc sect-ctr>
│ │ │ │ +    <[ref]block name="sect-${sect-ctr}" expand global>
│ │ │ │ +      <[ref]use block noexpand>
│ │ │ │ +    <[ref]/block>
│ │ │ │ +  <[ref]/blockdef>
│ │ │ │

│ │ │ │

│ │ │ │ Macros named "name" and "email" are set, and available inside the included │ │ │ │ file. They are not available, however, past the tag (which is why the │ │ │ │ second statement will fail.) │ │ │ │

│ │ │ │

TEMPLATE

│ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,36 +1,56 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: FFIILLEE ************ │ │ │ │ │ _T_a_b_l_e_ _o_f_ _C_o_n_t_e_n_t_s ********** ssyynnttaaxx ********** │ │ │ │ │ -  _I_n_t_r_o_d_u_c_t_i_o_n <_[_[_r_e_f_]_]_O_P_T (IMGXY|NOIMGXY)> │ │ │ │ │ -  _L_i_c_e_n_s_e <_[_[_r_e_f_]_]_O_P_T (QUIET|VERBOSE)> │ │ │ │ │ -  _T_u_t_o_r_i_a_l <_[_[_r_e_f_]_]_O_P_T (DEPEND|NODEPEND)> │ │ │ │ │ -  _U_s_a_g_e <_[_[_r_e_f_]_]_O_P_T (PRECIOUS|NOPRECIOUS)> │ │ │ │ │ -  HTP Tags <_[_[_r_e_f_]_]_O_P_T (CONDENSE|SEMICONDENSE|NOCONDENSE)> │ │ │ │ │ -    _A_L_T_T_E_X_T <_[_[_r_e_f_]_]_O_P_T DELIM=(HTML|SQUARE|CURLY)> │ │ │ │ │ -    _B_L_O_C_K <_[_[_r_e_f_]_]_O_P_T (XML|XML=FALSE)> │ │ │ │ │ -    _B_L_O_C_K_D_E_F │ │ │ │ │ -    _D_E_F ********** ssyynnooppssiiss ********** │ │ │ │ │ -  [>] _F_I_L_E FFIILLEE has several optional parameters of differing │ │ │ │ │ -    _I_F purpose. The output file's name, the current date │ │ │ │ │ -    _I_N_C and time, and the contents of another file may be │ │ │ │ │ -    _I_M_G included. Another file's time, date, or size may be │ │ │ │ │ -    _I_M_A_G_E_U_R_L added to the output file as well. │ │ │ │ │ -    _O_P_T As with all HTML, these tags do not have to be on │ │ │ │ │ -    _O_U_T_P_U_T their own line, so the following is perfectly │ │ │ │ │ -    _Q_U_O_T_E acceptable: │ │ │ │ │ -    _S_E_T ******** NNAAMMEE,, TTIIMMEE,, SSIIZZEE ******** │ │ │ │ │ -    _U_N_D_E_F To include information about another file, such as │ │ │ │ │ -    _U_N_S_E_T an archive file or graphic image, specify its name │ │ │ │ │ -    _U_S_E_,_ _$ with the NAME attribute followed by the type of │ │ │ │ │ -    _W_H_I_L_E information to be displayed: │ │ │ │ │ -    _<_!_-_-_- For file size information, the value BYTE, KBYTE, │ │ │ │ │ -  _H_i_s_t_o_r_y etc. dictates how the information is displayed. In │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t anything other than byte format, the information is │ │ │ │ │ -  _B_u_g_s displayed in floating-point notation. The amount of │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n ********** ssyynnooppssiiss ********** │ │ │ │ │ +  _L_i_c_e_n_s_e FFIILLEE has several optional parameters of differing │ │ │ │ │ +  _T_u_t_o_r_i_a_l purpose. The output file's name, the current date │ │ │ │ │ +  _U_s_a_g_e and time, and the contents of another file may be │ │ │ │ │ +  HTP Tags included. Another file's time, date, or size may be │ │ │ │ │ +    _A_L_T_T_E_X_T added to the output file as well. │ │ │ │ │ +    _B_L_O_C_K As with all HTML, these tags do not have to be on │ │ │ │ │ +    _B_L_O_C_K_D_E_F their own line, so the following is perfectly │ │ │ │ │ +    _D_E_F acceptable: │ │ │ │ │ +  [>] _F_I_L_E ******** NNAAMMEE,, TTIIMMEE,, SSIIZZEE ******** │ │ │ │ │ +    _I_F To include information about another file, such as │ │ │ │ │ +    _I_N_C an archive file or graphic image, specify its name │ │ │ │ │ +    _I_M_G with the NAME attribute followed by the type of │ │ │ │ │ +    _I_M_A_G_E_U_R_L information to be displayed: │ │ │ │ │ +    _O_P_T   <_[_[_r_e_f_]_]_D_E_F NAME="HEADERIMG" OPTION="SRC TITLE │ │ │ │ │ +    _O_U_T_P_U_T SIZE"> │ │ │ │ │ +    _Q_U_O_T_E     <_[_[_r_e_f_]_]_I_F size> │ │ │ │ │ +    _S_E_T         │ │ │ │ │ +    _U_N_D_E_F     <_[_[_r_e_f_]_]_/_I_F> │ │ │ │ │ +    _U_N_S_E_T     <_[_[_r_e_f_]_]_I_M_G SRC=pics/${src}> │ │ │ │ │ +    _U_S_E_,_ _$     <_[_[_r_e_f_]_]_U_S_E title> │ │ │ │ │ +    _W_H_I_L_E     <_[_[_r_e_f_]_]_I_F size> │ │ │ │ │ +    _<_!_-_-_-         │ │ │ │ │ +  _H_i_s_t_o_r_y     <_[_[_r_e_f_]_]_/_I_F> │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t   <_[_[_r_e_f_]_]_/_D_E_F> │ │ │ │ │ +  _B_u_g_s │ │ │ │ │ +   │ │ │ │ │ + │ │ │ │ │ +   │ │ │ │ │ + │ │ │ │ │ +   This will fail: │ │ │ │ │ +   │ │ │ │ │ + │ │ │ │ │ +   Instead, use * like this: │ │ │ │ │ +   <_[_[_r_e_f_]_]_D_E_F NAME="MYIMG" OPTION="SRC *"> │ │ │ │ │ +     <_[_[_r_e_f_]_]_I_M_G SRC="pics/${src}" $*> │ │ │ │ │ +   <_[_[_r_e_f_]_]_/_D_E_F> │ │ │ │ │ +     │ │ │ │ │ +   │ │ │ │ │ + For file size information, the value BYTE, KBYTE, │ │ │ │ │ + etc. dictates how the information is displayed. In │ │ │ │ │ + anything other than byte format, the information is │ │ │ │ │ + displayed in floating-point notation. The amount of │ │ │ │ │ precision (the number of digits to the right of the │ │ │ │ │ decimal point) can be set with the optional │ │ │ │ │ PRECISION attribute. The default precision is zero │ │ │ │ │ (0), which means no fractional portion is │ │ │ │ │ displayed. │ │ │ │ │ At the request of many people, the TIME and DATE │ │ │ │ │ attributes will now accept formatting characters │ │ │ │ │ @@ -57,14 +77,22 @@ │ │ │ │ │ Additional parameters can be set in the FILE │ │ │ │ │ INCLUDE tag, which are interpreted as macros that │ │ │ │ │ are "passed" to the included file. The macros are │ │ │ │ │ available only to the include file (and any macros │ │ │ │ │ or included files it holds). After the file is │ │ │ │ │ completely included, the macros are no longer │ │ │ │ │ available. So: │ │ │ │ │ +   <_[_[_r_e_f_]_]_s_e_t sect-ctr="0"> │ │ │ │ │ +   <_[_[_r_e_f_]_]_b_l_o_c_k_d_e_f name="section"> │ │ │ │ │ +     <_[_[_r_e_f_]_]_i_n_c sect-ctr> │ │ │ │ │ +     <_[_[_r_e_f_]_]_b_l_o_c_k name="sect-${sect-ctr}" expand │ │ │ │ │ + global> │ │ │ │ │ +       <_[_[_r_e_f_]_]_u_s_e block noexpand> │ │ │ │ │ +     <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ +   <_[_[_r_e_f_]_]_/_b_l_o_c_k_d_e_f> │ │ │ │ │ Macros named "name" and "email" are set, and │ │ │ │ │ available inside the included file. They are not │ │ │ │ │ available, however, past the tag (which is why the │ │ │ │ │ second statement will fail.) │ │ │ │ │ ******** TTEEMMPPLLAATTEE ******** │ │ │ │ │ A template file is nothing more than a default │ │ │ │ │ include file, one that is included once the input │ │ │ ├── ./usr/share/doc/htp/if.html │ │ │ │ @@ -127,15 +127,17 @@ │ │ │ │ string: │ │ │ │

│ │ │ │

│ │ │ │

│ │ │ │ and a defined operator is a test of a macro's existance: │ │ │ │

│ │ │ │

│ │ │ │ -    <${tagName} ${attrName}=${value$ctr}>
│ │ │ │ +<a href="mailto:$email">mailto hyperlink</a>
│ │ │ │ +<a href="http://$domain/~${username}/">another hyperlink</a>
│ │ │ │ +me>
│ │ │ │

│ │ │ │

│ │ │ │ If the NOT tag is present in the IF markup, the evaluation of the │ │ │ │ conditional is reversed. The first IF or ELSEIF condition that │ │ │ │ evaluates to true is chosen. If none of the conditions is true the │ │ │ │ ELSE block is taken if it is present. A conditional block │ │ │ │ must be closed with the /IF tag. IF tags can be nested. │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -6,38 +6,41 @@ │ │ │ │ │   _T_u_t_o_r_i_a_l blocks for conditional processing. The basic form │ │ │ │ │   _U_s_a_g_e is shown above. │ │ │ │ │   HTP Tags "Conditional" is either a "compare" or "is defined" │ │ │ │ │     _A_L_T_T_E_X_T operation. A compare operator is a test of the │ │ │ │ │     _B_L_O_C_K value of a macro against a literal string: │ │ │ │ │     _B_L_O_C_K_D_E_F and a defined operator is a test of a macro's │ │ │ │ │     _D_E_F existance: │ │ │ │ │ -    _F_I_L_E     <${tagName} ${attrName}=${value$ctr}> │ │ │ │ │ -  [>] _I_F If the NOT tag is present in the IF markup, the │ │ │ │ │ -    _I_N_C evaluation of the conditional is reversed. The │ │ │ │ │ -    _I_M_G first IF or ELSEIF condition that evaluates to true │ │ │ │ │ -    _I_M_A_G_E_U_R_L is chosen. If none of the conditions is true the │ │ │ │ │ -    _O_P_T ELSE block is taken if it is present. A conditional │ │ │ │ │ -    _O_U_T_P_U_T block mmuusstt be closed with the /IF tag. IF tags can │ │ │ │ │ -    _Q_U_O_T_E be nested. │ │ │ │ │ -    _S_E_T │ │ │ │ │ -    _U_N_D_E_F │ │ │ │ │ -    _U_N_S_E_T │ │ │ │ │ +    _F_I_L_E mailto hyperlink │ │ │ │ │ +  [>] _I_F another │ │ │ │ │ +    _I_N_C hyperlink │ │ │ │ │ +    _I_M_G me> │ │ │ │ │ +    _I_M_A_G_E_U_R_L If the NOT tag is present in the IF markup, the │ │ │ │ │ +    _O_P_T evaluation of the conditional is reversed. The │ │ │ │ │ +    _O_U_T_P_U_T first IF or ELSEIF condition that evaluates to true │ │ │ │ │ +    _Q_U_O_T_E is chosen. If none of the conditions is true the │ │ │ │ │ +    _S_E_T ELSE block is taken if it is present. A conditional │ │ │ │ │ +    _U_N_D_E_F block mmuusstt be closed with the /IF tag. IF tags can │ │ │ │ │ +    _U_N_S_E_T be nested. │ │ │ │ │     _U_S_E_,_ _$ │ │ │ │ │     _W_H_I_L_E │ │ │ │ │     _<_!_-_-_- │ │ │ │ │   _H_i_s_t_o_r_y │ │ │ │ │   _W_i_s_h_ _l_i_s_t │ │ │ │ │   _B_u_g_s │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │   _p_a_g_e_ _s_o_u_r_c_e │ │ │ │ │   _h_t_p_ _p_r_o_j_e_c_t │ │ │ │ │   _h_t_p_ _h_o_m_e_p_a_g_e │ │ │ ├── ./usr/share/doc/htp/inc.html │ │ │ │ @@ -128,14 +128,19 @@ │ │ │ │ macroname must be the name of a defined macro that contains an │ │ │ │ integer. If the increment is ommitted it defaults to 1. │ │ │ │ The effect of this operation is that the macro is redefined │ │ │ │ to contain the sum of its previous value and its increment. │ │ │ │

│ │ │ │ To increment or decrement a variable you can use this form: │ │ │ │

│ │ │ │ +  <[ref]def name="sharedimg" option="name alt">
│ │ │ │ +    <[ref]img src="/home/sharedimages/${name}" alt="${alt}">;
│ │ │ │ +  <[ref]/def>
│ │ │ │ +
│ │ │ │ +  <sharedimg name="bubble.gif" alt="Bubble image">
│ │ │ │

│ │ │ │

│ │ │ │ Note that INC doesn't check if the strings really denote integers. It │ │ │ │ may give weired results when used on arbitrary strings. The integer │ │ │ │ values are limited to the range -2^31..2^31. │ │ │ │

│ │ │ │ Note further that htp wasn't designed to do extensive calculations. │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -11,26 +11,32 @@ │ │ │ │ │     _B_L_O_C_K_D_E_F be the name of a defined macro that contains an │ │ │ │ │     _D_E_F integer. If the increment is ommitted it defaults │ │ │ │ │     _F_I_L_E to 1. The effect of this operation is that the │ │ │ │ │     _I_F macro is redefined to contain the sum of its │ │ │ │ │   [>] _I_N_C previous value and its increment. │ │ │ │ │     _I_M_G To increment or decrement a variable you can use │ │ │ │ │     _I_M_A_G_E_U_R_L this form: │ │ │ │ │ -    _O_P_T Note that INC doesn't check if the strings really │ │ │ │ │ -    _O_U_T_P_U_T denote integers. It may give weired results when │ │ │ │ │ -    _Q_U_O_T_E used on arbitrary strings. The integer values are │ │ │ │ │ -    _S_E_T limited to the range -2^31..2^31. │ │ │ │ │ -    _U_N_D_E_F Note further that htp wasn't designed to do │ │ │ │ │ -    _U_N_S_E_T extensive calculations. The INC tag is useful in │ │ │ │ │ -    _U_S_E_,_ _$ conjunction with WHILE to iterate over the defined │ │ │ │ │ -    _W_H_I_L_E blocks. │ │ │ │ │ -    _<_!_-_-_- │ │ │ │ │ -  _H_i_s_t_o_r_y │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t │ │ │ │ │ -  _B_u_g_s │ │ │ │ │ +    _O_P_T   <_[_[_r_e_f_]_]_d_e_f name="sharedimg" option="name alt"> │ │ │ │ │ +    _O_U_T_P_U_T     <_[_[_r_e_f_]_]_i_m_g src="/home/sharedimages/${name}" │ │ │ │ │ +    _Q_U_O_T_E alt="${alt}">; │ │ │ │ │ +    _S_E_T   <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ +    _U_N_D_E_F │ │ │ │ │ +    _U_N_S_E_T   │ │ │ │ │ +    _U_S_E_,_ _$ Note that INC doesn't check if the strings really │ │ │ │ │ +    _W_H_I_L_E denote integers. It may give weired results when │ │ │ │ │ +    _<_!_-_-_- used on arbitrary strings. The integer values are │ │ │ │ │ +  _H_i_s_t_o_r_y limited to the range -2^31..2^31. │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t Note further that htp wasn't designed to do │ │ │ │ │ +  _B_u_g_s extensive calculations. The INC tag is useful in │ │ │ │ │ + conjunction with WHILE to iterate over the defined │ │ │ │ │ + blocks. │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ ├── ./usr/share/doc/htp/metatag.html │ │ │ │ @@ -112,14 +112,16 @@ │ │ │ │

│ │ │ │

Using parameters

│ │ │ │

More sophisticated tags accept parameters. The │ │ │ │ option parameter lets multiple metatag parameters be │ │ │ │ named and expanded inside the def or │ │ │ │ blockdef block:

│ │ │ │

│ │ │ │ + 1.     <[ref]FILE INCLUDE="include.hti" name="Jim Nelson" email="jnelson@crl.com">
│ │ │ │ + 2.     This tag will fail: <[ref]USE name>
│ │ │ │

│ │ │ │

Saving blocks for later

│ │ │ │

When you are using templates, the html should only be written by │ │ │ │ the template file. The normal htp files should just define macros │ │ │ │ that are used later in the template. So you may want to write block │ │ │ │ tags that just save the block in a macro for later use. Although this │ │ │ │ is possible with htp it is quite tricky, so here we present the way to │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -32,14 +32,17 @@ │ │ │ │ │ these tags in a block macro named block. Here is an │ │ │ │ │ example for this. │ │ │ │ │ ********** UUssiinngg ppaarraammeetteerrss ********** │ │ │ │ │ More sophisticated tags accept parameters. The │ │ │ │ │ option parameter lets multiple metatag parameters │ │ │ │ │ be named and expanded inside the def or blockdef │ │ │ │ │ block: │ │ │ │ │ +  1.     <_[_[_r_e_f_]_]_F_I_L_E INCLUDE="include.hti" │ │ │ │ │ + name="Jim Nelson" email="jnelson@crl.com"> │ │ │ │ │ +  2.     This tag will fail: <_[_[_r_e_f_]_]_U_S_E name> │ │ │ │ │ ********** SSaavviinngg bblloocckkss ffoorr llaatteerr ********** │ │ │ │ │ When you are using templates, the html should only │ │ │ │ │ be written by the template file. The normal htp │ │ │ │ │ files should just define macros that are used later │ │ │ │ │ in the template. So you may want to write block │ │ │ │ │ tags that just save the block in a macro for later │ │ │ │ │ use. Although this is possible with htp it is quite │ │ │ ├── ./usr/share/doc/htp/quote.html │ │ │ │ @@ -114,14 +114,23 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ +  <[ref]def name="bigfont">
│ │ │ │ +    <font size="+4">
│ │ │ │ +  <[ref]/def>
│ │ │ │ +
│ │ │ │ +  <[ref]def name="/bigfont">
│ │ │ │ +    </font>
│ │ │ │ +  <[ref]/def>
│ │ │ │ +
│ │ │ │ +  <bigfont>Some large text</bigfont>
│ │ │ │

│ │ │ │

synopsis

│ │ │ │ QUOTE is used to quote a macro that would otherwise │ │ │ │ be interpreted by HTP. It may be useful in conjunction with a │ │ │ │ surrounding EXPANDed block to prevent early │ │ │ │ expansion of some contained blocks. Note that '$' evaluation is still │ │ │ │ done inside a quote block. │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,37 +1,46 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: QQUUOOTTEE ************ │ │ │ │ │ _T_a_b_l_e_ _o_f_ _C_o_n_t_e_n_t_s ********** ssyynnttaaxx ********** │ │ │ │ │ -  _I_n_t_r_o_d_u_c_t_i_o_n ********** ssyynnooppssiiss ********** │ │ │ │ │ -  _L_i_c_e_n_s_e QQUUOOTTEE is used to quote a macro that would otherwise │ │ │ │ │ -  _T_u_t_o_r_i_a_l be interpreted by HTP. It may be useful in │ │ │ │ │ -  _U_s_a_g_e conjunction with a surrounding _E_X_P_A_N_Ded block to │ │ │ │ │ -  HTP Tags prevent early expansion of some contained blocks. │ │ │ │ │ -    _A_L_T_T_E_X_T Note that '$' evaluation is still done inside a │ │ │ │ │ -    _B_L_O_C_K quote block. │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n   <_[_[_r_e_f_]_]_d_e_f name="bigfont"> │ │ │ │ │ +  _L_i_c_e_n_s_e     │ │ │ │ │ +  _T_u_t_o_r_i_a_l   <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ +  _U_s_a_g_e │ │ │ │ │ +  HTP Tags   <_[_[_r_e_f_]_]_d_e_f name="/bigfont"> │ │ │ │ │ +    _A_L_T_T_E_X_T     │ │ │ │ │ +    _B_L_O_C_K   <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │     _B_L_O_C_K_D_E_F │ │ │ │ │ -    _D_E_F │ │ │ │ │ -    _F_I_L_E │ │ │ │ │ -    _I_F │ │ │ │ │ -    _I_N_C │ │ │ │ │ -    _I_M_G │ │ │ │ │ -    _I_M_A_G_E_U_R_L │ │ │ │ │ -    _O_P_T │ │ │ │ │ -    _O_U_T_P_U_T │ │ │ │ │ +    _D_E_F   Some large text │ │ │ │ │ +    _F_I_L_E ********** ssyynnooppssiiss ********** │ │ │ │ │ +    _I_F QQUUOOTTEE is used to quote a macro that would otherwise │ │ │ │ │ +    _I_N_C be interpreted by HTP. It may be useful in │ │ │ │ │ +    _I_M_G conjunction with a surrounding _E_X_P_A_N_Ded block to │ │ │ │ │ +    _I_M_A_G_E_U_R_L prevent early expansion of some contained blocks. │ │ │ │ │ +    _O_P_T Note that '$' evaluation is still done inside a │ │ │ │ │ +    _O_U_T_P_U_T quote block. │ │ │ │ │   [>] _Q_U_O_T_E │ │ │ │ │     _S_E_T │ │ │ │ │     _U_N_D_E_F │ │ │ │ │     _U_N_S_E_T │ │ │ │ │     _U_S_E_,_ _$ │ │ │ │ │     _W_H_I_L_E │ │ │ │ │     _<_!_-_-_- │ │ │ │ │   _H_i_s_t_o_r_y │ │ │ │ │   _W_i_s_h_ _l_i_s_t │ │ │ │ │   _B_u_g_s │ │ │ │ │ │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │   _p_a_g_e_ _s_o_u_r_c_e │ │ │ │ │   _h_t_p_ _p_r_o_j_e_c_t │ │ │ │ │   _h_t_p_ _h_o_m_e_p_a_g_e │ │ │ │ │ hosted by │ │ │ │ │ _S_o_u_r_c_e_f_o_r_g_e │ │ │ │ │ HTML coding_[_P_o_w_e_r_e_d_ _b_y │ │ │ │ │ _h_t_p_] │ │ │ ├── ./usr/share/doc/htp/set.html │ │ │ │ @@ -114,19 +114,52 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ +<[ref]block stuff>
│ │ │ │ +  <a href=$email>send email</a>
│ │ │ │ +<[ref]/block>
│ │ │ │ +
│ │ │ │ +<[ref]set morestuff=$email>
│ │ │ │ +
│ │ │ │ +This works:     <[ref]use stuff email="jnelson@crl.com">
│ │ │ │ +But this fails: <[ref]use email>
│ │ │ │ +And this fails: <[ref]use morestuff email="jnelson@crl.com">
│ │ │ │

│ │ │ │

synopsis

│ │ │ │ SET creates a macro definition that can later be expanded │ │ │ │ anywhere in the HTML document. To create a macro: │ │ │ │

│ │ │ │ +  <[ref]DEF NAME="HEADERIMG" OPTION="SRC TITLE SIZE">
│ │ │ │ +    <[ref]IF size>
│ │ │ │ +        <FONT SIZE=${size}>
│ │ │ │ +    <[ref]/IF>
│ │ │ │ +    <[ref]IMG SRC=pics/${src}>
│ │ │ │ +    <[ref]USE title>
│ │ │ │ +    <[ref]IF size>
│ │ │ │ +        </FONT>
│ │ │ │ +    <[ref]/IF>
│ │ │ │ +  <[ref]/DEF>
│ │ │ │ +
│ │ │ │ +  <HEADERIMG SRC="logo.gif" SIZE="+2" TITLE="A title">
│ │ │ │ +
│ │ │ │ +  <HEADERIMG SRC="logo.gif" TITLE="Normal sized title">
│ │ │ │ +
│ │ │ │ +  This will fail:
│ │ │ │ +  <HEADERIMG SRC="logo.gif" ALT="Our logo" TITLE="Another title">
│ │ │ │ +
│ │ │ │ +  Instead, use * like this:
│ │ │ │ +  <[ref]DEF NAME="MYIMG" OPTION="SRC *">
│ │ │ │ +    <[ref]IMG SRC="pics/${src}" $*>
│ │ │ │ +  <[ref]/DEF>
│ │ │ │ +   
│ │ │ │ +  <MYIMG SRC="logo.gif" ALT="Our logo">
│ │ │ │

│ │ │ │

│ │ │ │ The macro "emailaddr" can then be expanded later. The │ │ │ │ USE tag is used to expand the macro outside a tag (i.e., into the regular │ │ │ │ text). If the macro needs to be expanded inside a markup tag, use the │ │ │ │ '$' operator. │ │ │ │

│ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,36 +1,75 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: SSEETT ************ │ │ │ │ │ _T_a_b_l_e_ _o_f_ _C_o_n_t_e_n_t_s ********** ssyynnttaaxx ********** │ │ │ │ │ -  _I_n_t_r_o_d_u_c_t_i_o_n ********** ssyynnooppssiiss ********** │ │ │ │ │ -  _L_i_c_e_n_s_e SSEETT creates a macro definition that can later be │ │ │ │ │ -  _T_u_t_o_r_i_a_l expanded anywhere in the HTML document. To create a │ │ │ │ │ -  _U_s_a_g_e macro: │ │ │ │ │ -  HTP Tags The macro "emailaddr" can then be expanded later. │ │ │ │ │ -    _A_L_T_T_E_X_T The _U_S_E tag is used to expand the macro outside a │ │ │ │ │ -    _B_L_O_C_K tag (i.e., into the regular text). If the macro │ │ │ │ │ -    _B_L_O_C_K_D_E_F needs to be expanded inside a markup tag, use the │ │ │ │ │ -    _D_E_F _'_$_' operator. │ │ │ │ │ -    _F_I_L_E Multiple macros can be declared in a single markup │ │ │ │ │ -    _I_F tag, as the second syntax line shows. │ │ │ │ │ -    _I_N_C SET should only be used for a single line's worth │ │ │ │ │ -    _I_M_G of text. Multi-line macros can be defined with the │ │ │ │ │ -    _I_M_A_G_E_U_R_L _B_L_O_C_K tag. The _B_L_O_C_K tag is also useful if the │ │ │ │ │ -    _O_P_T macro contains a quotation character and you don't │ │ │ │ │ -    _O_U_T_P_U_T want to fool around with special escape characters. │ │ │ │ │ -    _Q_U_O_T_E Macros can be redefined by using another SET │ │ │ │ │ -  [>] _S_E_T command with the same macro name. The prior │ │ │ │ │ -    _U_N_D_E_F definition will be destroyed, however. Also, the │ │ │ │ │ -    _U_N_S_E_T macro can be removed (destroyed) with the _U_N_S_E_T │ │ │ │ │ -    _U_S_E_,_ _$ tag. │ │ │ │ │ -    _W_H_I_L_E │ │ │ │ │ -    _<_!_-_-_- │ │ │ │ │ -  _H_i_s_t_o_r_y │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t │ │ │ │ │ -  _B_u_g_s │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n <_[_[_r_e_f_]_]_b_l_o_c_k stuff> │ │ │ │ │ +  _L_i_c_e_n_s_e   send email │ │ │ │ │ +  _T_u_t_o_r_i_a_l <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ +  _U_s_a_g_e │ │ │ │ │ +  HTP Tags <_[_[_r_e_f_]_]_s_e_t morestuff=$email> │ │ │ │ │ +    _A_L_T_T_E_X_T │ │ │ │ │ +    _B_L_O_C_K This works:     <_[_[_r_e_f_]_]_u_s_e stuff │ │ │ │ │ +    _B_L_O_C_K_D_E_F email="jnelson@crl.com"> │ │ │ │ │ +    _D_E_F But this fails: <_[_[_r_e_f_]_]_u_s_e email> │ │ │ │ │ +    _F_I_L_E And this fails: <_[_[_r_e_f_]_]_u_s_e morestuff │ │ │ │ │ +    _I_F email="jnelson@crl.com"> │ │ │ │ │ +    _I_N_C ********** ssyynnooppssiiss ********** │ │ │ │ │ +    _I_M_G SSEETT creates a macro definition that can later be │ │ │ │ │ +    _I_M_A_G_E_U_R_L expanded anywhere in the HTML document. To create a │ │ │ │ │ +    _O_P_T macro: │ │ │ │ │ +    _O_U_T_P_U_T   <_[_[_r_e_f_]_]_D_E_F NAME="HEADERIMG" OPTION="SRC TITLE │ │ │ │ │ +    _Q_U_O_T_E SIZE"> │ │ │ │ │ +  [>] _S_E_T     <_[_[_r_e_f_]_]_I_F size> │ │ │ │ │ +    _U_N_D_E_F         │ │ │ │ │ +    _U_N_S_E_T     <_[_[_r_e_f_]_]_/_I_F> │ │ │ │ │ +    _U_S_E_,_ _$     <_[_[_r_e_f_]_]_I_M_G SRC=pics/${src}> │ │ │ │ │ +    _W_H_I_L_E     <_[_[_r_e_f_]_]_U_S_E title> │ │ │ │ │ +    _<_!_-_-_-     <_[_[_r_e_f_]_]_I_F size> │ │ │ │ │ +  _H_i_s_t_o_r_y         │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t     <_[_[_r_e_f_]_]_/_I_F> │ │ │ │ │ +  _B_u_g_s   <_[_[_r_e_f_]_]_/_D_E_F> │ │ │ │ │ + │ │ │ │ │ +   │ │ │ │ │ + │ │ │ │ │ +   │ │ │ │ │ + │ │ │ │ │ +   This will fail: │ │ │ │ │ +   │ │ │ │ │ + │ │ │ │ │ +   Instead, use * like this: │ │ │ │ │ +   <_[_[_r_e_f_]_]_D_E_F NAME="MYIMG" OPTION="SRC *"> │ │ │ │ │ +     <_[_[_r_e_f_]_]_I_M_G SRC="pics/${src}" $*> │ │ │ │ │ +   <_[_[_r_e_f_]_]_/_D_E_F> │ │ │ │ │ +     │ │ │ │ │ +   │ │ │ │ │ + The macro "emailaddr" can then be expanded later. │ │ │ │ │ + The _U_S_E tag is used to expand the macro outside a │ │ │ │ │ + tag (i.e., into the regular text). If the macro │ │ │ │ │ + needs to be expanded inside a markup tag, use the │ │ │ │ │ + _'_$_' operator. │ │ │ │ │ + Multiple macros can be declared in a single markup │ │ │ │ │ + tag, as the second syntax line shows. │ │ │ │ │ + SET should only be used for a single line's worth │ │ │ │ │ + of text. Multi-line macros can be defined with the │ │ │ │ │ + _B_L_O_C_K tag. The _B_L_O_C_K tag is also useful if the │ │ │ │ │ + macro contains a quotation character and you don't │ │ │ │ │ + want to fool around with special escape characters. │ │ │ │ │ + Macros can be redefined by using another SET │ │ │ │ │ + command with the same macro name. The prior │ │ │ │ │ + definition will be destroyed, however. Also, the │ │ │ │ │ + macro can be removed (destroyed) with the _U_N_S_E_T │ │ │ │ │ + tag. │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │ + │ │ │ ├── ./usr/share/doc/htp/tut/jh.html │ │ │ │ @@ -16,10 +16,10 @@ │ │ │ │ Phone:+49 761 203-8243 │ │ │ │ Fax:+49 761 203-8242 │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

│ │ │ │ Copyright by Joe Doe.
│ │ │ │ - last updated Sat Apr 27, 2024 │ │ │ │ + last updated Fri May 30, 2025 │ │ │ │ │ │ │ │ │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,8 +1,8 @@ │ │ │ │ │ ************ JJoocchheenn HHooeenniicckkee ************ │ │ │ │ │ Navigation bar [Photo] │ │ │ │ │ _M_a_i_n RRoooomm:: Bld.52 00-020 │ │ │ │ │ _E_x_a_m_p_l_e PPhhoonnee:: +49 761 203-8243 │ │ │ │ │ FFaaxx:: +49 761 203-8242 │ │ │ │ │ =============================================================================== │ │ │ │ │ Copyright by _J_o_e_ _D_o_e. │ │ │ │ │ -last updated Sat Apr 27, 2024 │ │ │ │ │ +last updated Fri May 30, 2025 │ │ │ ├── ./usr/share/doc/htp/tut/tut1.html │ │ │ │ @@ -5,9 +5,9 @@ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ This page was produced by htp. │ │ │ │
│ │ │ │ Copyright by Joe Doe, │ │ │ │ webmaster@domain.com, │ │ │ │ -last updated Sat Apr 27, 2024 │ │ │ │ +last updated Fri May 30, 2025 │ │ │ │ │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,3 +1,3 @@ │ │ │ │ │ This page was produced by htp. │ │ │ │ │ =============================================================================== │ │ │ │ │ -Copyright by Joe Doe, _w_e_b_m_a_s_t_e_r_@_d_o_m_a_i_n_._c_o_m, last updated Sat Apr 27, 2024 │ │ │ │ │ +Copyright by Joe Doe, _w_e_b_m_a_s_t_e_r_@_d_o_m_a_i_n_._c_o_m, last updated Fri May 30, 2025 │ │ │ ├── ./usr/share/doc/htp/tut/tut2.html │ │ │ │ @@ -13,10 +13,10 @@ │ │ │ │

│ │ │ │ As you can see the file contains almost only the contents. │ │ │ │

│ │ │ │ │ │ │ │ │ │ │ │
│ │ │ │ Copyright by Joe Doe.
│ │ │ │ - last updated Sat Apr 27, 2024 │ │ │ │ + last updated Fri May 30, 2025 │ │ │ │ │ │ │ │ │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,6 +1,6 @@ │ │ │ │ │ Navigation bar ********** HHeerree iiss tthhee ccoonntteenntt ********** │ │ │ │ │ _M_a_i_n As you can see the file contains almost only the contents. │ │ │ │ │ _E_x_a_m_p_l_e │ │ │ │ │ =============================================================================== │ │ │ │ │ Copyright by _J_o_e_ _D_o_e. │ │ │ │ │ -last updated Sat Apr 27, 2024 │ │ │ │ │ +last updated Fri May 30, 2025 │ │ │ ├── ./usr/share/doc/htp/tut/tut3.html │ │ │ │ @@ -13,10 +13,10 @@ │ │ │ │

│ │ │ │ As you can see the file contains almost only the contents. │ │ │ │

│ │ │ │ │ │ │ │ │ │ │ │
│ │ │ │ Copyright by Joe Doe.
│ │ │ │ - last updated Sat Apr 27, 2024 │ │ │ │ + last updated Fri May 30, 2025 │ │ │ │ │ │ │ │ │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,6 +1,6 @@ │ │ │ │ │ Navigation bar ********** HHeerree aarree tthhee ccoonntteennttss ********** │ │ │ │ │ _M_a_i_n As you can see the file contains almost only the contents. │ │ │ │ │ _E_x_a_m_p_l_e │ │ │ │ │ =============================================================================== │ │ │ │ │ Copyright by _J_o_e_ _D_o_e. │ │ │ │ │ -last updated Sat Apr 27, 2024 │ │ │ │ │ +last updated Fri May 30, 2025 │ │ │ ├── ./usr/share/doc/htp/undef.html │ │ │ │ @@ -114,14 +114,15 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ +    <[ref]SET emailaddr="jnelson@crl.com">
│ │ │ │

│ │ │ │

synopsis

│ │ │ │

UNDEF removes a metatag definition. Metatags │ │ │ │ created by DEF and BLOCKDEF can be removed with the UNDEF │ │ │ │ command. Once removed, the metatag will no longer be recognized by │ │ │ │ htp until it is reassigned.

│ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,18 +1,18 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: UUNNDDEEFF ************ │ │ │ │ │ _T_a_b_l_e_ _o_f_ _C_o_n_t_e_n_t_s ********** ssyynnttaaxx ********** │ │ │ │ │ -  _I_n_t_r_o_d_u_c_t_i_o_n ********** ssyynnooppssiiss ********** │ │ │ │ │ -  _L_i_c_e_n_s_e UUNNDDEEFF removes a metatag definition. Metatags │ │ │ │ │ -  _T_u_t_o_r_i_a_l created by _D_E_F and _B_L_O_C_K_D_E_F can be removed with the │ │ │ │ │ -  _U_s_a_g_e UNDEF command. Once removed, the metatag will no │ │ │ │ │ -  HTP Tags longer be recognized by htp until it is reassigned. │ │ │ │ │ -    _A_L_T_T_E_X_T Multiple metatags can be removed by placing each │ │ │ │ │ -    _B_L_O_C_K name as an attribute. │ │ │ │ │ -    _B_L_O_C_K_D_E_F │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n     <_[_[_r_e_f_]_]_S_E_T emailaddr="jnelson@crl.com"> │ │ │ │ │ +  _L_i_c_e_n_s_e ********** ssyynnooppssiiss ********** │ │ │ │ │ +  _T_u_t_o_r_i_a_l UUNNDDEEFF removes a metatag definition. Metatags │ │ │ │ │ +  _U_s_a_g_e created by _D_E_F and _B_L_O_C_K_D_E_F can be removed with the │ │ │ │ │ +  HTP Tags UNDEF command. Once removed, the metatag will no │ │ │ │ │ +    _A_L_T_T_E_X_T longer be recognized by htp until it is reassigned. │ │ │ │ │ +    _B_L_O_C_K Multiple metatags can be removed by placing each │ │ │ │ │ +    _B_L_O_C_K_D_E_F name as an attribute. │ │ │ │ │     _D_E_F │ │ │ │ │     _F_I_L_E │ │ │ │ │     _I_F │ │ │ │ │     _I_N_C │ │ │ │ │     _I_M_G │ │ │ │ │     _I_M_A_G_E_U_R_L │ │ │ │ │     _O_P_T │ │ │ │ │ @@ -24,14 +24,15 @@ │ │ │ │ │     _U_S_E_,_ _$ │ │ │ │ │     _W_H_I_L_E │ │ │ │ │     _<_!_-_-_- │ │ │ │ │   _H_i_s_t_o_r_y │ │ │ │ │   _W_i_s_h_ _l_i_s_t │ │ │ │ │   _B_u_g_s │ │ │ │ │ │ │ │ │ │ + │ │ │ │ │   _p_a_g_e_ _s_o_u_r_c_e │ │ │ │ │   _h_t_p_ _p_r_o_j_e_c_t │ │ │ │ │   _h_t_p_ _h_o_m_e_p_a_g_e │ │ │ │ │ hosted by │ │ │ │ │ _S_o_u_r_c_e_f_o_r_g_e │ │ │ │ │ HTML coding_[_P_o_w_e_r_e_d_ _b_y │ │ │ │ │ _h_t_p_] │ │ │ ├── ./usr/share/doc/htp/unset.html │ │ │ │ @@ -114,30 +114,32 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ +    <[ref]SET emailaddr="jnelson@crl.com">
│ │ │ │

│ │ │ │

synopsis

│ │ │ │ UNSET removes (or deletes) a macro and it's definition. │ │ │ │ The macro is subsequently not available for use in the pre-processed files. │ │ │ │ (Note that simply redefining the macro with another SET or │ │ │ │ BLOCK definition with the same name is acceptable. The │ │ │ │ old macro definition will be removed automatically.) │ │ │ │

│ │ │ │ For example: │ │ │ │

│ │ │ │ +    <[ref]FILE INCLUDE="include.hti" name="Jim Nelson" email="jnelson@crl.com">
│ │ │ │ +    This tag will fail: <[ref]USE name>
│ │ │ │

│ │ │ │

│ │ │ │ More than one macro may be removed in the same tag: │ │ │ │

│ │ │ │ -    <[ref]FILE INCLUDE="include.hti" name="Jim Nelson" email="jnelson@crl.com">
│ │ │ │ -    This tag will fail: <[ref]USE name>
│ │ │ │ +    <${tagName} ${attrName}=${value$ctr}>
│ │ │ │

│ │ │ │

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,25 +1,25 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: UUNNSSEETT ************ │ │ │ │ │ _T_a_b_l_e_ _o_f_ _C_o_n_t_e_n_t_s ********** ssyynnttaaxx ********** │ │ │ │ │ -  _I_n_t_r_o_d_u_c_t_i_o_n ********** ssyynnooppssiiss ********** │ │ │ │ │ -  _L_i_c_e_n_s_e UUNNSSEETT removes (or deletes) a macro and it's │ │ │ │ │ -  _T_u_t_o_r_i_a_l definition. The macro is subsequently not available │ │ │ │ │ -  _U_s_a_g_e for use in the pre-processed files. (Note that │ │ │ │ │ -  HTP Tags simply redefining the macro with another _S_E_T or │ │ │ │ │ -    _A_L_T_T_E_X_T _B_L_O_C_K definition with the same name is acceptable. │ │ │ │ │ -    _B_L_O_C_K The old macro definition will be removed │ │ │ │ │ -    _B_L_O_C_K_D_E_F automatically.) │ │ │ │ │ -    _D_E_F For example: │ │ │ │ │ -    _F_I_L_E More than one macro may be removed in the same tag: │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n     <_[_[_r_e_f_]_]_S_E_T emailaddr="jnelson@crl.com"> │ │ │ │ │ +  _L_i_c_e_n_s_e ********** ssyynnooppssiiss ********** │ │ │ │ │ +  _T_u_t_o_r_i_a_l UUNNSSEETT removes (or deletes) a macro and it's │ │ │ │ │ +  _U_s_a_g_e definition. The macro is subsequently not available │ │ │ │ │ +  HTP Tags for use in the pre-processed files. (Note that │ │ │ │ │ +    _A_L_T_T_E_X_T simply redefining the macro with another _S_E_T or │ │ │ │ │ +    _B_L_O_C_K _B_L_O_C_K definition with the same name is acceptable. │ │ │ │ │ +    _B_L_O_C_K_D_E_F The old macro definition will be removed │ │ │ │ │ +    _D_E_F automatically.) │ │ │ │ │ +    _F_I_L_E For example: │ │ │ │ │     _I_F     <_[_[_r_e_f_]_]_F_I_L_E INCLUDE="include.hti" name="Jim │ │ │ │ │     _I_N_C Nelson" email="jnelson@crl.com"> │ │ │ │ │     _I_M_G     This tag will fail: <_[_[_r_e_f_]_]_U_S_E name> │ │ │ │ │ -    _I_M_A_G_E_U_R_L │ │ │ │ │ -    _O_P_T │ │ │ │ │ +    _I_M_A_G_E_U_R_L More than one macro may be removed in the same tag: │ │ │ │ │ +    _O_P_T     <${tagName} ${attrName}=${value$ctr}> │ │ │ │ │     _O_U_T_P_U_T │ │ │ │ │     _Q_U_O_T_E │ │ │ │ │     _S_E_T │ │ │ │ │     _U_N_D_E_F │ │ │ │ │   [>] _U_N_S_E_T │ │ │ │ │     _U_S_E_,_ _$ │ │ │ │ │     _W_H_I_L_E │ │ │ │ │ @@ -30,14 +30,16 @@ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ + │ │ │ │ │ + │ │ │ │ │   _p_a_g_e_ _s_o_u_r_c_e │ │ │ │ │   _h_t_p_ _p_r_o_j_e_c_t │ │ │ │ │   _h_t_p_ _h_o_m_e_p_a_g_e │ │ │ │ │ hosted by │ │ │ │ │ _S_o_u_r_c_e_f_o_r_g_e │ │ │ │ │ HTML coding_[_P_o_w_e_r_e_d_ _b_y │ │ │ │ │ _h_t_p_] │ │ │ ├── ./usr/share/doc/htp/use.html │ │ │ │ @@ -114,14 +114,15 @@ │ │ │ │ Bugs │ │ │ │
│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ +    <[ref]INC i="1" j="-1">
│ │ │ │

│ │ │ │

synopsis

│ │ │ │ USE will expand macros that have been previously │ │ │ │ declared with either SET or BLOCK. USE can only be used outside of other │ │ │ │ markup tags. │ │ │ │

If you USE a block macro the value of expanded block macros will │ │ │ │ @@ -131,14 +132,36 @@ │ │ │ │ attribute to prevent further expansion.

│ │ │ │

USE will accept additional parameters, which are "local" macros │ │ │ │ for the expanded macro. This is only valid for BLOCK macros. Macros created using SET cannot have parameters passed. For │ │ │ │ example:

│ │ │ │

│ │ │ │ + 1.   <[ref]def name="sharedimg" option="name alt">
│ │ │ │ + 2.     <[ref]img src="/home/sharedimages/${name}" alt="${alt}">;
│ │ │ │ + 3.   <[ref]/def>
│ │ │ │ + 4.
│ │ │ │ + 5.   <sharedimg name="bubble.gif" alt="Bubble image">
│ │ │ │ + 6.     </FONT>
│ │ │ │ + 7.     <[ref]/IF>
│ │ │ │ + 8.   <[ref]/DEF>
│ │ │ │ + 9.
│ │ │ │ +10.   <HEADERIMG SRC="logo.gif" SIZE="+2" TITLE="A title">
│ │ │ │ +11.
│ │ │ │ +12.   <HEADERIMG SRC="logo.gif" TITLE="Normal sized title">
│ │ │ │ +13.
│ │ │ │ +14.   This will fail:
│ │ │ │ +15.   <HEADERIMG SRC="logo.gif" ALT="Our logo" TITLE="Another title">
│ │ │ │ +16.
│ │ │ │ +17.   Instead, use * like this:
│ │ │ │ +18.   <[ref]DEF NAME="MYIMG" OPTION="SRC *">
│ │ │ │ +19.     <[ref]IMG SRC="pics/${src}" $*>
│ │ │ │ +20.   <[ref]/DEF>
│ │ │ │ +21.    
│ │ │ │ +22.   <MYIMG SRC="logo.gif" ALT="Our logo">
│ │ │ │

│ │ │ │

│ │ │ │ (See below for a description of the '$' operator.) The example on │ │ │ │ line 7 works because "stuff" has been declared as a block macro, and │ │ │ │ the tag is passing the "email" macro to the "stuff" macro. Line 8 │ │ │ │ fails because the "email" macro is unavailable once the block macro is │ │ │ │ completely expanded, and cannot be passed to a SET macro. │ │ │ │ @@ -177,15 +200,21 @@ │ │ │ │ delimiting the text as if it were additional markup attributes. │ │ │ │ If the '$' macro is surrounded by other text (as in the two examples above), │ │ │ │ quotation marks are not automatically supplied. │ │ │ │

│ │ │ │ Note that a '$' macro can be placed anywhere in a markup tag and can │ │ │ │ be nested. This is valid: │ │ │ │

│ │ │ │ -    <${tagName} ${attrName}=${value$ctr}>
│ │ │ │ +<[ref]file include="header.hti">
│ │ │ │ +  <[ref]set sect-ctr="1">
│ │ │ │ +  <[ref]while sect-${sect-ctr}>
│ │ │ │ +    <[ref]use sect-${sect-ctr}>
│ │ │ │ +    <[ref]inc sect-ctr>
│ │ │ │ +  <[ref]/while>
│ │ │ │ +<[ref]file include="footer.hti">
│ │ │ │

│ │ │ │

The tagName macro can contain any tag name, even a self-defined │ │ │ │ metatag. Note that $ctr is expanded before the valueX │ │ │ │ macro is expanded, so assuming that ctr was set to 1 it will expand │ │ │ │ value1. │ │ │ │

│ │ │ │ │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,36 +1,65 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: UUSSEE,, $$ ************ │ │ │ │ │ _T_a_b_l_e_ _o_f_ _C_o_n_t_e_n_t_s ********** ssyynnttaaxx ********** │ │ │ │ │ -  _I_n_t_r_o_d_u_c_t_i_o_n ********** ssyynnooppssiiss ********** │ │ │ │ │ -  _L_i_c_e_n_s_e UUSSEE will expand macros that have been previously │ │ │ │ │ -  _T_u_t_o_r_i_a_l declared with either _S_E_T or _B_L_O_C_K. USE can only be │ │ │ │ │ -  _U_s_a_g_e used outside of other markup tags. │ │ │ │ │ -  HTP Tags If you USE a block macro the value of expanded │ │ │ │ │ -    _A_L_T_T_E_X_T block macros will be further parsed by htp. This is │ │ │ │ │ -    _B_L_O_C_K maybe not what you want, for example, if the use is │ │ │ │ │ -    _B_L_O_C_K_D_E_F inside a block which _e_x_p_a_n_d_s itself. You can use │ │ │ │ │ -    _D_E_F the noexpand attribute to prevent further │ │ │ │ │ -    _F_I_L_E expansion. │ │ │ │ │ -    _I_F USE will accept additional parameters, which are │ │ │ │ │ -    _I_N_C "local" macros for the expanded macro. This is only │ │ │ │ │ -    _I_M_G valid for _B_L_O_C_K macros. Macros created using _S_E_T │ │ │ │ │ -    _I_M_A_G_E_U_R_L cannot have parameters passed. For example: │ │ │ │ │ -    _O_P_T (See below for a description of the '$' operator.) │ │ │ │ │ -    _O_U_T_P_U_T The example on line 7 works because "stuff" has │ │ │ │ │ -    _Q_U_O_T_E been declared as a block macro, and the tag is │ │ │ │ │ -    _S_E_T passing the "email" macro to the "stuff" macro. │ │ │ │ │ -    _U_N_D_E_F Line 8 fails because the "email" macro is │ │ │ │ │ -    _U_N_S_E_T unavailable once the block macro is completely │ │ │ │ │ -  [>] _U_S_E_,_ _$ expanded, and cannot be passed to a SET macro. │ │ │ │ │ -    _W_H_I_L_E Note that the "email" macro is available to other │ │ │ │ │ -    _<_!_-_-_- macros or included files called within the "stuff" │ │ │ │ │ -  _H_i_s_t_o_r_y block. │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t Inside a markup tag, like _I_M_G, A (anchor), or any │ │ │ │ │ -  _B_u_g_s other standard HTML or htp tag, the '$' operator │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n     <_[_[_r_e_f_]_]_I_N_C i="1" j="-1"> │ │ │ │ │ +  _L_i_c_e_n_s_e ********** ssyynnooppssiiss ********** │ │ │ │ │ +  _T_u_t_o_r_i_a_l UUSSEE will expand macros that have been previously │ │ │ │ │ +  _U_s_a_g_e declared with either _S_E_T or _B_L_O_C_K. USE can only be │ │ │ │ │ +  HTP Tags used outside of other markup tags. │ │ │ │ │ +    _A_L_T_T_E_X_T If you USE a block macro the value of expanded │ │ │ │ │ +    _B_L_O_C_K block macros will be further parsed by htp. This is │ │ │ │ │ +    _B_L_O_C_K_D_E_F maybe not what you want, for example, if the use is │ │ │ │ │ +    _D_E_F inside a block which _e_x_p_a_n_d_s itself. You can use │ │ │ │ │ +    _F_I_L_E the noexpand attribute to prevent further │ │ │ │ │ +    _I_F expansion. │ │ │ │ │ +    _I_N_C USE will accept additional parameters, which are │ │ │ │ │ +    _I_M_G "local" macros for the expanded macro. This is only │ │ │ │ │ +    _I_M_A_G_E_U_R_L valid for _B_L_O_C_K macros. Macros created using _S_E_T │ │ │ │ │ +    _O_P_T cannot have parameters passed. For example: │ │ │ │ │ +    _O_U_T_P_U_T  1.   <_[_[_r_e_f_]_]_d_e_f name="sharedimg" option="name │ │ │ │ │ +    _Q_U_O_T_E alt"> │ │ │ │ │ +    _S_E_T  2.     <_[_[_r_e_f_]_]_i_m_g src="/home/sharedimages/$ │ │ │ │ │ +    _U_N_D_E_F {name}" alt="${alt}">; │ │ │ │ │ +    _U_N_S_E_T  3.   <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ +  [>] _U_S_E_,_ _$  4. │ │ │ │ │ +    _W_H_I_L_E  5.   │ │ │ │ │ +  _H_i_s_t_o_r_y  6.     │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t  7.     <_[_[_r_e_f_]_]_/_I_F> │ │ │ │ │ +  _B_u_g_s  8.   <_[_[_r_e_f_]_]_/_D_E_F> │ │ │ │ │ +  9. │ │ │ │ │ + 10.   │ │ │ │ │ + 11. │ │ │ │ │ + 12.   │ │ │ │ │ + 13. │ │ │ │ │ + 14.   This will fail: │ │ │ │ │ + 15.   │ │ │ │ │ + 16. │ │ │ │ │ + 17.   Instead, use * like this: │ │ │ │ │ + 18.   <_[_[_r_e_f_]_]_D_E_F NAME="MYIMG" OPTION="SRC *"> │ │ │ │ │ + 19.     <_[_[_r_e_f_]_]_I_M_G SRC="pics/${src}" $*> │ │ │ │ │ + 20.   <_[_[_r_e_f_]_]_/_D_E_F> │ │ │ │ │ + 21.     │ │ │ │ │ + 22.   │ │ │ │ │ + (See below for a description of the '$' operator.) │ │ │ │ │ + The example on line 7 works because "stuff" has │ │ │ │ │ + been declared as a block macro, and the tag is │ │ │ │ │ + passing the "email" macro to the "stuff" macro. │ │ │ │ │ + Line 8 fails because the "email" macro is │ │ │ │ │ + unavailable once the block macro is completely │ │ │ │ │ + expanded, and cannot be passed to a SET macro. │ │ │ │ │ + Note that the "email" macro is available to other │ │ │ │ │ + macros or included files called within the "stuff" │ │ │ │ │ + block. │ │ │ │ │ + Inside a markup tag, like _I_M_G, A (anchor), or any │ │ │ │ │ + other standard HTML or htp tag, the '$' operator │ │ │ │ │ must be used. The '$' should be immediately │ │ │ │ │ followed by the macro name, which may or may not be │ │ │ │ │ surrounded by curly braces. When htp encounters │ │ │ │ │ this it replaces the macro name by the contents of │ │ │ │ │ the macro without further processing the contents. │ │ │ │ │  1.   <_[_[_r_e_f_]_]_s_e_t sect-ctr="0"> │ │ │ │ │  2.   <_[_[_r_e_f_]_]_b_l_o_c_k_d_e_f name="section"> │ │ │ │ │ @@ -55,15 +84,21 @@ │ │ │ │ │ it with quotation marks to prevent spaces from │ │ │ │ │ delimiting the text as if it were additional markup │ │ │ │ │ attributes. If the '$' macro is surrounded by other │ │ │ │ │ text (as in the two examples above), quotation │ │ │ │ │ marks are not automatically supplied. │ │ │ │ │ Note that a '$' macro can be placed anywhere in a │ │ │ │ │ markup tag and can be nested. This is valid: │ │ │ │ │ -     <${tagName} ${attrName}=${value$ctr}> │ │ │ │ │ + <_[_[_r_e_f_]_]_f_i_l_e include="header.hti"> │ │ │ │ │ +   <_[_[_r_e_f_]_]_s_e_t sect-ctr="1"> │ │ │ │ │ +   <_[_[_r_e_f_]_]_w_h_i_l_e sect-${sect-ctr}> │ │ │ │ │ +     <_[_[_r_e_f_]_]_u_s_e sect-${sect-ctr}> │ │ │ │ │ +     <_[_[_r_e_f_]_]_i_n_c sect-ctr> │ │ │ │ │ +   <_[_[_r_e_f_]_]_/_w_h_i_l_e> │ │ │ │ │ + <_[_[_r_e_f_]_]_f_i_l_e include="footer.hti"> │ │ │ │ │ The tagName macro can contain any tag name, even a │ │ │ │ │ self-defined metatag. Note that $ctr is expanded │ │ │ │ │ before the valueX macro is expanded, so assuming │ │ │ │ │ that ctr was set to 1 it will expand value1. │ │ │ ├── ./usr/share/doc/htp/while.html │ │ │ │ @@ -114,36 +114,34 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ +    <[ref]SET emailaddr="jnelson@crl.com">
│ │ │ │

│ │ │ │

synopsis

│ │ │ │ WHILE is the building block for repeated processing. │ │ │ │ The basic form is shown above. │ │ │ │

│ │ │ │ "Conditional" is either a "compare" or "is defined" operation. │ │ │ │ A compare operator is a test of the value of a macro against a literal string. │ │ │ │ If the NOT tag is present in the WHILE markup, the evaluation of the │ │ │ │ conditional is reversed: │ │ │ │

│ │ │ │ +<a href="mailto:$email">mailto hyperlink</a>
│ │ │ │ +<a href="http://$domain/~${username}/">another hyperlink</a>
│ │ │ │ +me>
│ │ │ │

│ │ │ │

│ │ │ │ Just as with [ref]IF you can also check for a │ │ │ │ macro's existance: │ │ │ │

│ │ │ │ -  <[ref]set sect-ctr="0">
│ │ │ │ -  <[ref]blockdef name="section">
│ │ │ │ -    <[ref]inc sect-ctr>
│ │ │ │ -    <[ref]block name="sect-${sect-ctr}" expand global>
│ │ │ │ -      <[ref]use block noexpand>
│ │ │ │ -    <[ref]/block>
│ │ │ │ -  <[ref]/blockdef>
│ │ │ │ +    <${tagName} ${attrName}=${value$ctr}>
│ │ │ │

│ │ │ │

│ │ │ │ If the condition is true, the block is evaluated and afterwards the │ │ │ │ WHILE tag is evaluated again. If the '$'-operator is used in the │ │ │ │ WHILE tag it is also reevaluated on each iteration. │ │ │ │

│ │ │ │ A loop block must be closed with the /WHILE tag. │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,45 +1,43 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: WWHHIILLEE ************ │ │ │ │ │ _T_a_b_l_e_ _o_f_ _C_o_n_t_e_n_t_s ********** ssyynnttaaxx ********** │ │ │ │ │ -  _I_n_t_r_o_d_u_c_t_i_o_n ********** ssyynnooppssiiss ********** │ │ │ │ │ -  _L_i_c_e_n_s_e WWHHIILLEE is the building block for repeated │ │ │ │ │ -  _T_u_t_o_r_i_a_l processing. The basic form is shown above. │ │ │ │ │ -  _U_s_a_g_e "Conditional" is either a "compare" or "is defined" │ │ │ │ │ -  HTP Tags operation. A compare operator is a test of the │ │ │ │ │ -    _A_L_T_T_E_X_T value of a macro against a literal string. If the │ │ │ │ │ -    _B_L_O_C_K NOT tag is present in the WHILE markup, the │ │ │ │ │ -    _B_L_O_C_K_D_E_F evaluation of the conditional is reversed: │ │ │ │ │ -    _D_E_F Just as with _[_[_r_e_f_]_]_I_F you can also check for a │ │ │ │ │ -    _F_I_L_E macro's existance: │ │ │ │ │ -    _I_F   <_[_[_r_e_f_]_]_s_e_t sect-ctr="0"> │ │ │ │ │ -    _I_N_C   <_[_[_r_e_f_]_]_b_l_o_c_k_d_e_f name="section"> │ │ │ │ │ -    _I_M_G     <_[_[_r_e_f_]_]_i_n_c sect-ctr> │ │ │ │ │ -    _I_M_A_G_E_U_R_L     <_[_[_r_e_f_]_]_b_l_o_c_k name="sect-${sect-ctr}" expand │ │ │ │ │ -    _O_P_T global> │ │ │ │ │ -    _O_U_T_P_U_T       <_[_[_r_e_f_]_]_u_s_e block noexpand> │ │ │ │ │ -    _Q_U_O_T_E     <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ -    _S_E_T   <_[_[_r_e_f_]_]_/_b_l_o_c_k_d_e_f> │ │ │ │ │ -    _U_N_D_E_F If the condition is true, the block is evaluated │ │ │ │ │ -    _U_N_S_E_T and afterwards the WHILE tag is evaluated again. If │ │ │ │ │ -    _U_S_E_,_ _$ the '$'-operator is used in the WHILE tag it is │ │ │ │ │ -  [>] _W_H_I_L_E also reevaluated on each iteration. │ │ │ │ │ -    _<_!_-_-_- A loop block mmuusstt be closed with the /WHILE tag. │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n     <_[_[_r_e_f_]_]_S_E_T emailaddr="jnelson@crl.com"> │ │ │ │ │ +  _L_i_c_e_n_s_e ********** ssyynnooppssiiss ********** │ │ │ │ │ +  _T_u_t_o_r_i_a_l WWHHIILLEE is the building block for repeated │ │ │ │ │ +  _U_s_a_g_e processing. The basic form is shown above. │ │ │ │ │ +  HTP Tags "Conditional" is either a "compare" or "is defined" │ │ │ │ │ +    _A_L_T_T_E_X_T operation. A compare operator is a test of the │ │ │ │ │ +    _B_L_O_C_K value of a macro against a literal string. If the │ │ │ │ │ +    _B_L_O_C_K_D_E_F NOT tag is present in the WHILE markup, the │ │ │ │ │ +    _D_E_F evaluation of the conditional is reversed: │ │ │ │ │ +    _F_I_L_E mailto hyperlink │ │ │ │ │ +    _I_F another │ │ │ │ │ +    _I_N_C hyperlink │ │ │ │ │ +    _I_M_G me> │ │ │ │ │ +    _I_M_A_G_E_U_R_L Just as with _[_[_r_e_f_]_]_I_F you can also check for a │ │ │ │ │ +    _O_P_T macro's existance: │ │ │ │ │ +    _O_U_T_P_U_T     <${tagName} ${attrName}=${value$ctr}> │ │ │ │ │ +    _Q_U_O_T_E If the condition is true, the block is evaluated │ │ │ │ │ +    _S_E_T and afterwards the WHILE tag is evaluated again. If │ │ │ │ │ +    _U_N_D_E_F the '$'-operator is used in the WHILE tag it is │ │ │ │ │ +    _U_N_S_E_T also reevaluated on each iteration. │ │ │ │ │ +    _U_S_E_,_ _$ A loop block mmuusstt be closed with the /WHILE tag. │ │ │ │ │ +  [>] _W_H_I_L_E │ │ │ │ │ +    _<_!_-_-_- │ │ │ │ │   _H_i_s_t_o_r_y │ │ │ │ │   _W_i_s_h_ _l_i_s_t │ │ │ │ │   _B_u_g_s │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ - │ │ │ │ │ -