--- /srv/reproducible-results/rbuild-debian/r-b-build.yijYzrAH/b1/htp_1.19-8_arm64.changes +++ /srv/reproducible-results/rbuild-debian/r-b-build.yijYzrAH/b2/htp_1.19-8_arm64.changes ├── Files │ @@ -1,3 +1,3 @@ │ │ fd6b5971556ebb2f09f4454160da8d92 70392 debug optional htp-dbgsym_1.19-8_arm64.deb │ - 539af1c0f2b48c9fe957eabf17e4ec00 116356 web optional htp_1.19-8_arm64.deb │ + 012faaa1e245c64143d735cc3bafd5a6 116764 web optional htp_1.19-8_arm64.deb ├── htp_1.19-8_arm64.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 112552 2020-06-14 23:21:19.000000 data.tar.xz │ │ +-rw-r--r-- 0 0 0 112960 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: arm64 │ │ │ │ Maintainer: Marcelo Soares Mota │ │ │ │ -Installed-Size: 649 │ │ │ │ +Installed-Size: 642 │ │ │ │ Depends: libc6 (>= 2.38) │ │ │ │ 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) 67816 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) 8782 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/alttext.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 9020 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) 8386 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/block.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 8456 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) 8571 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/blockdef.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 8972 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) 13177 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/comment.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 9196 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) 14863 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/def.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 17701 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,45 +32,45 @@ │ │ │ │ -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) 9644 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/expand.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 11553 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) 15462 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/file.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 14305 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) 9354 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/if.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 9039 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) 10135 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/imageurl.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 9541 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) 8907 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/img.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 8639 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) 12226 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/inc.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 8940 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) 13728 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/metatag.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 19291 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) 11327 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/opt.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 9118 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) 8130 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 │ │ │ │ drwxr-xr-x 0 root (0) root (0) 0 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/pic/ │ │ │ │ -rw-r--r-- 0 root (0) root (0) 171 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/pic/arrow.png │ │ │ │ @@ -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) 7959 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/quote.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 7748 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) 10867 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/set.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 9037 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) 8633 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/undef.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 7759 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) 10797 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/unset.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 8629 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) 13282 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/use.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 13505 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) 11109 2020-06-14 23:21:19.000000 ./usr/share/doc/htp/while.html │ │ │ │ +-rw-r--r-- 0 root (0) root (0) 10616 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 │ │ │ │ @@ -114,32 +114,33 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ -<[ref]img src="filename" ...>
│ │ │ │ +<[ref]alttext name="imagename" [ text="imagetext" ]>
│ │ │ │
│ │ │ │

│ │ │ │

synopsis

│ │ │ │ ALTTEXT declares an ALT attribute for any IMG tag with a SRC matching the ALTTEXT NAME. │ │ │ │ Since relative paths can be used to point to the same image, only the │ │ │ │ filename is considered in all comparisons. │ │ │ │

│ │ │ │ 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]if disabled_because_xyz>
│ │ │ │ -  ...
│ │ │ │ -<[ref]/if>
│ │ │ │ +<[ref]BLOCK NAME="blockname" [GLOBAL] [EXPAND]>
│ │ │ │ +text block
│ │ │ │ +<[ref]/BLOCK>
│ │ │ │ +
│ │ │ │

│ │ │ │

│ │ │ │ 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 {} │ │ │ │ │ @@ -1,36 +1,38 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: AALLTTTTEEXXTT ************ │ │ │ │ │ _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_]_]_i_m_g src="filename" ...> │ │ │ │ │ -  _L_i_c_e_n_s_e │ │ │ │ │ -  _T_u_t_o_r_i_a_l ********** ssyynnooppssiiss ********** │ │ │ │ │ -  _U_s_a_g_e AALLTTTTEEXXTT declares an ALT attribute for any _I_M_G tag │ │ │ │ │ -  HTP Tags with a SRC matching the ALTTEXT NAME. Since │ │ │ │ │ -  [>] _A_L_T_T_E_X_T relative paths can be used to point to the same │ │ │ │ │ -    _B_L_O_C_K image, only the filename is considered in all │ │ │ │ │ -    _B_L_O_C_K_D_E_F comparisons. │ │ │ │ │ -    _D_E_F When an IMG tag with a matching source is │ │ │ │ │ -    _F_I_L_E encountered, htp will add an ALT attribute only if │ │ │ │ │ -    _I_F one is not already present. This allows for ALT │ │ │ │ │ -    _I_N_C text to be overridden on specific images and │ │ │ │ │ -    _I_M_G default text on all others. │ │ │ │ │ -    _I_M_A_G_E_U_R_L For example: │ │ │ │ │ -    _O_P_T <_[_[_r_e_f_]_]_i_f disabled_because_xyz> │ │ │ │ │ -    _O_U_T_P_U_T   ... │ │ │ │ │ -    _Q_U_O_T_E <_[_[_r_e_f_]_]_/_i_f> │ │ │ │ │ -    _S_E_T An ALTTEXT tag with a name but no text attribute │ │ │ │ │ -    _U_N_D_E_F removes any ALT mapping for this image. Successing │ │ │ │ │ -    _U_N_S_E_T IMG tags with a matching SRC name are not changed. │ │ │ │ │ -    _U_S_E_,_ _$ Since this is useful for an image used throughout a │ │ │ │ │ -    _W_H_I_L_E set of documents, ALTTEXT is most appropriate in an │ │ │ │ │ -    _<_!_-_-_- _i_n_c_l_u_d_e_ _f_i_l_e or a _d_e_f_a_u_l_t_ _f_i_l_e. │ │ │ │ │ -  _H_i_s_t_o_r_y In addition to ALTTEXT, htp can also automatically │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t add WIDTH and HEIGHT attributes to _I_M_G tags. │ │ │ │ │ -  _B_u_g_s │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n <_[_[_r_e_f_]_]_a_l_t_t_e_x_t name="imagename" [ text="imagetext" │ │ │ │ │ +  _L_i_c_e_n_s_e ]> │ │ │ │ │ +  _T_u_t_o_r_i_a_l │ │ │ │ │ +  _U_s_a_g_e ********** ssyynnooppssiiss ********** │ │ │ │ │ +  HTP Tags AALLTTTTEEXXTT declares an ALT attribute for any _I_M_G tag │ │ │ │ │ +  [>] _A_L_T_T_E_X_T with a SRC matching the ALTTEXT NAME. Since │ │ │ │ │ +    _B_L_O_C_K relative paths can be used to point to the same │ │ │ │ │ +    _B_L_O_C_K_D_E_F image, only the filename is considered in all │ │ │ │ │ +    _D_E_F comparisons. │ │ │ │ │ +    _F_I_L_E When an IMG tag with a matching source is │ │ │ │ │ +    _I_F encountered, htp will add an ALT attribute only if │ │ │ │ │ +    _I_N_C one is not already present. This allows for ALT │ │ │ │ │ +    _I_M_G text to be overridden on specific images and │ │ │ │ │ +    _I_M_A_G_E_U_R_L default text on all others. │ │ │ │ │ +    _O_P_T For example: │ │ │ │ │ +    _O_U_T_P_U_T <_[_[_r_e_f_]_]_B_L_O_C_K NAME="blockname" [GLOBAL] [EXPAND]> │ │ │ │ │ +    _Q_U_O_T_E text block │ │ │ │ │ +    _S_E_T <_[_[_r_e_f_]_]_/_B_L_O_C_K> │ │ │ │ │ +    _U_N_D_E_F │ │ │ │ │ +    _U_N_S_E_T An ALTTEXT tag with a name but no text attribute │ │ │ │ │ +    _U_S_E_,_ _$ removes any ALT mapping for this image. Successing │ │ │ │ │ +    _W_H_I_L_E IMG tags with a matching SRC name are not changed. │ │ │ │ │ +    _<_!_-_-_- Since this is useful for an image used throughout a │ │ │ │ │ +  _H_i_s_t_o_r_y set of documents, ALTTEXT is most appropriate in an │ │ │ │ │ +  _W_i_s_h_ _l_i_s_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. │ │ │ │ │ +  _B_u_g_s In addition to ALTTEXT, htp can also automatically │ │ │ │ │ + add WIDTH and HEIGHT attributes to _I_M_G tags. │ │ │ │ │ + │ │ │ ├── ./usr/share/doc/htp/block.html │ │ │ │ @@ -114,15 +114,17 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ -<[ref]INC macroname1="increment1" [macroname2="increment2" ... ] [GLOBAL]>
│ │ │ │ +<[ref]BLOCK NAME="blockname" [GLOBAL] [EXPAND]>
│ │ │ │ +text block
│ │ │ │ +<[ref]/BLOCK>
│ │ │ │
│ │ │ │

│ │ │ │

synopsis

│ │ │ │

│ │ │ │ BLOCK and /BLOCK are used to create block macros, which │ │ │ │ are similar in use to SET macros, but can be │ │ │ │ multi-line definitions. │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,26 +1,26 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: BBLLOOCCKK,, //BBLLOOCCKK ************ │ │ │ │ │ _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_]_]_I_N_C macroname1="increment1" │ │ │ │ │ -  _L_i_c_e_n_s_e [macroname2="increment2" ... ] [GLOBAL]> │ │ │ │ │ -  _T_u_t_o_r_i_a_l │ │ │ │ │ -  _U_s_a_g_e ********** ssyynnooppssiiss ********** │ │ │ │ │ -  HTP Tags BBLLOOCCKK aanndd //BBLLOOCCKK are used to create block macros, │ │ │ │ │ -    _A_L_T_T_E_X_T which are similar in use to _S_E_T macros, but can be │ │ │ │ │ -  [>] _B_L_O_C_K multi-line definitions. │ │ │ │ │ -    _B_L_O_C_K_D_E_F Any text and formatting may be set inside the │ │ │ │ │ -    _D_E_F block. You can use any htp or user defined metatag │ │ │ │ │ -    _F_I_L_E including _F_I_L_E_ _I_N_C_L_U_D_E. The metatags won't be │ │ │ │ │ -    _I_F expanded before the block is USEd except if you │ │ │ │ │ -    _I_N_C give the _E_X_P_A_N_D parameter. │ │ │ │ │ -    _I_M_G The block macro is dereferenced (expanded) with the │ │ │ │ │ -    _I_M_A_G_E_U_R_L _U_S_E_ _t_a_g_ _o_r_ _t_h_e_ _'_$_'_ _o_p_e_r_a_t_o_r. See the notes on the │ │ │ │ │ -    _O_P_T _U_S_E tag on how to pass parameters to a block macro. │ │ │ │ │ -    _O_U_T_P_U_T │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n <_[_[_r_e_f_]_]_B_L_O_C_K NAME="blockname" [GLOBAL] [EXPAND]> │ │ │ │ │ +  _L_i_c_e_n_s_e text block │ │ │ │ │ +  _T_u_t_o_r_i_a_l <_[_[_r_e_f_]_]_/_B_L_O_C_K> │ │ │ │ │ +  _U_s_a_g_e │ │ │ │ │ +  HTP Tags ********** ssyynnooppssiiss ********** │ │ │ │ │ +    _A_L_T_T_E_X_T BBLLOOCCKK aanndd //BBLLOOCCKK are used to create block macros, │ │ │ │ │ +  [>] _B_L_O_C_K which are similar in use to _S_E_T macros, but can be │ │ │ │ │ +    _B_L_O_C_K_D_E_F multi-line definitions. │ │ │ │ │ +    _D_E_F Any text and formatting may be set inside the │ │ │ │ │ +    _F_I_L_E block. You can use any htp or user defined metatag │ │ │ │ │ +    _I_F including _F_I_L_E_ _I_N_C_L_U_D_E. The metatags won't be │ │ │ │ │ +    _I_N_C expanded before the block is USEd except if you │ │ │ │ │ +    _I_M_G give the _E_X_P_A_N_D parameter. │ │ │ │ │ +    _I_M_A_G_E_U_R_L The block macro is dereferenced (expanded) with the │ │ │ │ │ +    _O_P_T _U_S_E_ _t_a_g_ _o_r_ _t_h_e_ _'_$_'_ _o_p_e_r_a_t_o_r. See the notes on the │ │ │ │ │ +    _O_U_T_P_U_T _U_S_E tag on how to pass parameters to a block macro. │ │ │ │ │     _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,15 @@ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ + │ │ │ │ │ │ │ │ │ │ │ │ │ │ │   _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 │ │ │ ├── ./usr/share/doc/htp/blockdef.html │ │ │ │ @@ -114,30 +114,30 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ +<[ref]blockdef name="tagname" [option="option1 [option2 ...]" ] [global] [expand]>
│ │ │ │ +  ... <[ref]use block> ...
│ │ │ │ +<[ref]/blockdef>
│ │ │ │ +
│ │ │ │

│ │ │ │

synopsis

│ │ │ │ BLOCKDEF creates block metatags, which is a fancy way of saying it │ │ │ │ creates new block tags. A block tag is a tag that takes a whole block │ │ │ │ as additional parameter. This block is surrounded by <tagname> and │ │ │ │ </tagname>. The contents of this block are automatically stored │ │ │ │ in the block macro named BLOCK. │ │ │ │

For example:

│ │ │ │

│ │ │ │ -    <[ref]def name="centered">
│ │ │ │ -    <p align=center>
│ │ │ │ -    <[ref]/def>
│ │ │ │ +<!--- comment --->
│ │ │ │
│ │ │ │ -    <centered>
│ │ │ │ -    This text is centered.
│ │ │ │

│ │ │ │

│ │ │ │ All block metatags have the implicit option EXPAND, which tells htp to expand the contents │ │ │ │ of the block before the definition is expanded. │ │ │ │

│ │ │ │

│ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,43 +1,44 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: BBLLOOCCKKDDEEFF,, //BBLLOOCCKKDDEEFF ************ │ │ │ │ │ _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 BBLLOOCCKKDDEEFF creates block _m_e_t_a_t_a_g_s, which is a fancy │ │ │ │ │ -  _T_u_t_o_r_i_a_l way of saying it creates new block tags. A block │ │ │ │ │ -  _U_s_a_g_e tag is a tag that takes a whole block as additional │ │ │ │ │ -  HTP Tags parameter. This block is surrounded by │ │ │ │ │ -    _A_L_T_T_E_X_T and . The contents of this block are │ │ │ │ │ -    _B_L_O_C_K automatically stored in the block macro named │ │ │ │ │ -  [>] _B_L_O_C_K_D_E_F BLOCK. │ │ │ │ │ -    _D_E_F For example: │ │ │ │ │ -    _F_I_L_E     <_[_[_r_e_f_]_]_d_e_f name="centered"> │ │ │ │ │ -    _I_F    

│ │ │ │ │ -    _I_N_C     <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ -    _I_M_G │ │ │ │ │ -    _I_M_A_G_E_U_R_L     │ │ │ │ │ -    _O_P_T     This text is centered. │ │ │ │ │ -    _O_U_T_P_U_T All block metatags have the implicit option _E_X_P_A_N_D, │ │ │ │ │ -    _Q_U_O_T_E which tells htp to expand the contents of the block │ │ │ │ │ -    _S_E_T before the definition is expanded. │ │ │ │ │ -    _U_N_D_E_F A more thorough discussion and more elaborate │ │ │ │ │ -    _U_N_S_E_T examples are discussed in the _m_e_t_a_t_a_g section. │ │ │ │ │ -    _U_S_E_,_ _$ │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n <_[_[_r_e_f_]_]_b_l_o_c_k_d_e_f name="tagname" [option="option1 │ │ │ │ │ +  _L_i_c_e_n_s_e [option2 ...]" ] [global] [expand]> │ │ │ │ │ +  _T_u_t_o_r_i_a_l   ... <_[_[_r_e_f_]_]_u_s_e block> ... │ │ │ │ │ +  _U_s_a_g_e <_[_[_r_e_f_]_]_/_b_l_o_c_k_d_e_f> │ │ │ │ │ +  HTP Tags │ │ │ │ │ +    _A_L_T_T_E_X_T ********** ssyynnooppssiiss ********** │ │ │ │ │ +    _B_L_O_C_K BBLLOOCCKKDDEEFF creates block _m_e_t_a_t_a_g_s, which is a fancy │ │ │ │ │ +  [>] _B_L_O_C_K_D_E_F way of saying it creates new block tags. A block │ │ │ │ │ +    _D_E_F tag is a tag that takes a whole block as additional │ │ │ │ │ +    _F_I_L_E parameter. This block is surrounded by │ │ │ │ │ +    _I_F and . The contents of this block are │ │ │ │ │ +    _I_N_C automatically stored in the block macro named │ │ │ │ │ +    _I_M_G BLOCK. │ │ │ │ │ +    _I_M_A_G_E_U_R_L For example: │ │ │ │ │ +    _O_P_T │ │ │ │ │ +    _O_U_T_P_U_T │ │ │ │ │ +    _Q_U_O_T_E All block metatags have the implicit option _E_X_P_A_N_D, │ │ │ │ │ +    _S_E_T which tells htp to expand the contents of the block │ │ │ │ │ +    _U_N_D_E_F before the definition is expanded. │ │ │ │ │ +    _U_N_S_E_T A more thorough discussion and more elaborate │ │ │ │ │ +    _U_S_E_,_ _$ examples are discussed in the _m_e_t_a_t_a_g section. │ │ │ │ │     _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/comment.html │ │ │ │ @@ -114,68 +114,39 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ -  <[ref]blockdef name="section" option="title">
│ │ │ │ -   <h1><[ref]use title></h1>
│ │ │ │ -   <p class="section">
│ │ │ │ -     <[ref]use block>
│ │ │ │ -   </p>
│ │ │ │ -  <[ref]/blockdef>
│ │ │ │ +<[ref]def name="tagname" [option="option1 [option2 ...]" ] [global] [expand]>
│ │ │ │ +<[ref]/def>
│ │ │ │
│ │ │ │ -  <section title="My Section">
│ │ │ │ -    This is a fancy section.
│ │ │ │ -  </section>
│ │ │ │

│ │ │ │

synopsis

│ │ │ │

│ │ │ │ This is a simple comment that is not included in the output. This is useful │ │ │ │ when commenting metatags, since the metatags do not appear the output either. │ │ │ │ Example: │ │ │ │

│ │ │ │

│ │ │ │ -  <[ref]imageurl url="http://my.domain.org/" path="/var/www/my.domain/">
│ │ │ │ -  <[ref]imageurl url="other.domain.org/" path="/var/www/other.domain/">
│ │ │ │ -
│ │ │ │ -  For this line: <[ref]img src="logo.gif">
│ │ │ │ -  the local filename "logo.gif" will be used to determine image dimensions
│ │ │ │ -  (no URL replacement).
│ │ │ │ -
│ │ │ │ -  For this line: <[ref]img src="http://my.domain.org/logo.gif">
│ │ │ │ -  the local filename "/var/www/my.domain/logo.gif" will be used.
│ │ │ │ -
│ │ │ │ -  But for this line: <[ref]img src="http://other.domain.org/logo.gif">
│ │ │ │ -  the local file cannot be found (no prefix match), so the image dimensions
│ │ │ │ -  will not be added.
│ │ │ │ -
│ │ │ │ -  Order is important; last IMAGEURL tag takes precedence:
│ │ │ │ -  <[ref]imageurl url="/" path="/var/www/htdocs/">
│ │ │ │ -  <[ref]imageurl url="/test/" path="/var/www/test/">
│ │ │ │ -
│ │ │ │ -  <[ref]img src="/image.gif"> and <[ref]img src="/test/image.gif"> are mapped to
│ │ │ │ -  /var/www/htdocs/image.gif and /var/www/test/image.gif, resp.
│ │ │ │ -  If the order of the imageurl lines would be swapped, the second
│ │ │ │ -  image would be mapped to /var/www/htdocs/test/image.gif.
│ │ │ │ +<!--- This comment doesn't appear in the HTML file --->
│ │ │ │

│ │ │ │

│ │ │ │ Note that these comments should not include < or >, that is you │ │ │ │ should not use it to comment out htp code. For that purpose use something │ │ │ │ like this: │ │ │ │

│ │ │ │

│ │ │ │ -  <[ref]blockdef name="bolditalic">
│ │ │ │ -    <b><i>
│ │ │ │ -    <[ref]use block>
│ │ │ │ -    </i></b>
│ │ │ │ -  <[ref]/blockdef>
│ │ │ │ +    <[ref]def name="centered">
│ │ │ │ +    <p align=center>
│ │ │ │ +    <[ref]/def>
│ │ │ │
│ │ │ │ -  This is <bolditalic>bold and italic</bolditalic>
│ │ │ │ +    <centered>
│ │ │ │ +    This text is centered.
│ │ │ │

│ │ │ │

Make sure that the variable is never defined and xyz should be the │ │ │ │ reason why you don't want to include this block

│ │ │ │

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,76 +1,36 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: < │ │ │ │ │ -  _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 ********** ssyynnooppssiiss ********** │ │ │ │ │ -    _I_N_C This is a simple comment that is not included in │ │ │ │ │ -    _I_M_G the output. This is useful when commenting │ │ │ │ │ -    _I_M_A_G_E_U_R_L metatags, since the metatags do not appear the │ │ │ │ │ -    _O_P_T output either. Example: │ │ │ │ │ -    _O_U_T_P_U_T   <_[_[_r_e_f_]_]_i_m_a_g_e_u_r_l url="http://my.domain.org/ │ │ │ │ │ -    _Q_U_O_T_E " path="/var/www/my.domain/"> │ │ │ │ │ -    _S_E_T   <_[_[_r_e_f_]_]_i_m_a_g_e_u_r_l url="other.domain.org/" path="/ │ │ │ │ │ -    _U_N_D_E_F var/www/other.domain/"> │ │ │ │ │ -    _U_N_S_E_T │ │ │ │ │ -    _U_S_E_,_ _$   For this line: <_[_[_r_e_f_]_]_i_m_g src="logo.gif"> │ │ │ │ │ -    _W_H_I_L_E   the local filename "logo.gif" will be used to │ │ │ │ │ -  [>] _<_!_-_-_- determine image dimensions │ │ │ │ │ -  _H_i_s_t_o_r_y   (no URL replacement). │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n <_[_[_r_e_f_]_]_d_e_f name="tagname" [option="option1 │ │ │ │ │ +  _L_i_c_e_n_s_e [option2 ...]" ] [global] [expand]> │ │ │ │ │ +  _T_u_t_o_r_i_a_l <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ +  _U_s_a_g_e │ │ │ │ │ +  HTP Tags ********** ssyynnooppssiiss ********** │ │ │ │ │ +    _A_L_T_T_E_X_T This is a simple comment that is not included in │ │ │ │ │ +    _B_L_O_C_K the output. This is useful when commenting │ │ │ │ │ +    _B_L_O_C_K_D_E_F metatags, since the metatags do not appear the │ │ │ │ │ +    _D_E_F output either. Example: │ │ │ │ │ +    _F_I_L_E │ │ │ │ │ +    _I_N_C Note that these comments should not include < or >, │ │ │ │ │ +    _I_M_G that is you should not use it to comment out htp │ │ │ │ │ +    _I_M_A_G_E_U_R_L code. For that purpose use something like this: │ │ │ │ │ +    _O_P_T     <_[_[_r_e_f_]_]_d_e_f name="centered"> │ │ │ │ │ +    _O_U_T_P_U_T    

│ │ │ │ │ +    _Q_U_O_T_E     <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ +    _S_E_T │ │ │ │ │ +    _U_N_D_E_F     │ │ │ │ │ +    _U_N_S_E_T     This text is centered. │ │ │ │ │ +    _U_S_E_,_ _$ Make sure that the variable is never defined and │ │ │ │ │ +    _W_H_I_L_E xyz should be the reason why you don't want to │ │ │ │ │ +  [>] _<_!_-_-_- include this block │ │ │ │ │ +  _H_i_s_t_o_r_y │ │ │ │ │   _W_i_s_h_ _l_i_s_t │ │ │ │ │ -  _B_u_g_s   For this line: <_[_[_r_e_f_]_]_i_m_g src="http:// │ │ │ │ │ - my.domain.org/logo.gif"> │ │ │ │ │ -   the local filename "/var/www/my.domain/logo.gif" │ │ │ │ │ - will be used. │ │ │ │ │ - │ │ │ │ │ -   But for this line: <_[_[_r_e_f_]_]_i_m_g src="http:// │ │ │ │ │ - other.domain.org/logo.gif"> │ │ │ │ │ -   the local file cannot be found (no prefix match), │ │ │ │ │ - so the image dimensions │ │ │ │ │ -   will not be added. │ │ │ │ │ - │ │ │ │ │ -   Order is important; last IMAGEURL tag takes │ │ │ │ │ - precedence: │ │ │ │ │ -   <_[_[_r_e_f_]_]_i_m_a_g_e_u_r_l url="/" path="/var/www/htdocs/"> │ │ │ │ │ -   <_[_[_r_e_f_]_]_i_m_a_g_e_u_r_l url="/test/" path="/var/www/ │ │ │ │ │ - test/"> │ │ │ │ │ - │ │ │ │ │ -   <_[_[_r_e_f_]_]_i_m_g src="/image.gif"> and <_[_[_r_e_f_]_]_i_m_g │ │ │ │ │ - src="/test/image.gif"> are mapped to │ │ │ │ │ -   /var/www/htdocs/image.gif and /var/www/test/ │ │ │ │ │ - image.gif, resp. │ │ │ │ │ -   If the order of the imageurl lines would be │ │ │ │ │ - swapped, the second │ │ │ │ │ -   image would be mapped to /var/www/htdocs/test/ │ │ │ │ │ - image.gif. │ │ │ │ │ - Note that these comments should not include < or >, │ │ │ │ │ - that is you should not use it to comment out htp │ │ │ │ │ - code. For that purpose use something like this: │ │ │ │ │ -   <_[_[_r_e_f_]_]_b_l_o_c_k_d_e_f name="bolditalic"> │ │ │ │ │ -     │ │ │ │ │ -     <_[_[_r_e_f_]_]_u_s_e block> │ │ │ │ │ -     │ │ │ │ │ -   <_[_[_r_e_f_]_]_/_b_l_o_c_k_d_e_f> │ │ │ │ │ - │ │ │ │ │ -   This is bold and italic │ │ │ │ │ - Make sure that the variable is never defined and │ │ │ │ │ - xyz should be the reason why you don't want to │ │ │ │ │ - include this block │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ +  _B_u_g_s │ │ │ ├── ./usr/share/doc/htp/def.html │ │ │ │ @@ -114,78 +114,85 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ -<[ref]INC macroname1="increment1" [macroname2="increment2" ... ] [GLOBAL]>
│ │ │ │ -
│ │ │ │ +<!--- This comment doesn't appear in the HTML file --->
│ │ │ │

│ │ │ │

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. │ │ │ │ For example: │ │ │ │

│ │ │ │

│ │ │ │ -  <[ref]imageurl url="http://my.domain.org/" path="/var/www/my.domain/">
│ │ │ │ -  <[ref]imageurl url="other.domain.org/" path="/var/www/other.domain/">
│ │ │ │ -
│ │ │ │ -  For this line: <[ref]img src="logo.gif">
│ │ │ │ -  the local filename "logo.gif" will be used to determine image dimensions
│ │ │ │ -  (no URL replacement).
│ │ │ │ -
│ │ │ │ -  For this line: <[ref]img src="http://my.domain.org/logo.gif">
│ │ │ │ -  the local filename "/var/www/my.domain/logo.gif" will be used.
│ │ │ │ -
│ │ │ │ -  But for this line: <[ref]img src="http://other.domain.org/logo.gif">
│ │ │ │ -  the local file cannot be found (no prefix match), so the image dimensions
│ │ │ │ -  will not be added.
│ │ │ │ +    <[ref]def name="centered">
│ │ │ │ +    <p align=center>
│ │ │ │ +    <[ref]/def>
│ │ │ │
│ │ │ │ -  Order is important; last IMAGEURL tag takes precedence:
│ │ │ │ -  <[ref]imageurl url="/" path="/var/www/htdocs/">
│ │ │ │ -  <[ref]imageurl url="/test/" path="/var/www/test/">
│ │ │ │ -
│ │ │ │ -  <[ref]img src="/image.gif"> and <[ref]img src="/test/image.gif"> are mapped to
│ │ │ │ -  /var/www/htdocs/image.gif and /var/www/test/image.gif, resp.
│ │ │ │ -  If the order of the imageurl lines would be swapped, the second
│ │ │ │ -  image would be mapped to /var/www/htdocs/test/image.gif.
│ │ │ │ +    <centered>
│ │ │ │ +    This text is centered.
│ │ │ │

│ │ │ │

│ │ │ │ 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]blockdef name="bolditalic">
│ │ │ │ -    <b><i>
│ │ │ │ -    <[ref]use block>
│ │ │ │ -    </i></b>
│ │ │ │ -  <[ref]/blockdef>
│ │ │ │ -
│ │ │ │ -  This is <bolditalic>bold and italic</bolditalic>
│ │ │ │ +  <[ref]set time="0">
│ │ │ │ +  <[ref]block name=a>
│ │ │ │ +    a is expanded at time <[ref]use time>.
│ │ │ │ +  <[ref]/block>
│ │ │ │ +  <[ref]block name=b expand>
│ │ │ │ +    b is expanded at time <[ref]use time>.
│ │ │ │ +  <[ref]/block>
│ │ │ │ +  <[ref]set time="1">
│ │ │ │ +  <[ref]use a>
│ │ │ │ +  <[ref]use b>
│ │ │ │ +  contents of a: <[ref]use a noexpand>
│ │ │ │ +  contents of b: <[ref]use b noexpand>
│ │ │ │ +  <[ref]block name=c expand>
│ │ │ │ +    c is expanded at time <[ref]use time>; <[ref]use a>
│ │ │ │ +  <[ref]/block>
│ │ │ │ +  <[ref]block name=d expand>
│ │ │ │ +    d is expanded at time <[ref]use time>; <[ref]use a noexpand>
│ │ │ │ +  <[ref]/block>
│ │ │ │ +  <[ref]block name=e>
│ │ │ │ +    e is expanded at time <[ref]use time>; <[ref]use a noexpand>
│ │ │ │ +  <[ref]/block>
│ │ │ │ +  <[ref]set time="2">
│ │ │ │ +  <[ref]block name=a>
│ │ │ │ +    a is defined for the 2nd time <[ref]use time>.
│ │ │ │ +  <[ref]/block>
│ │ │ │ +  <[ref]use c>
│ │ │ │ +  <[ref]use d>
│ │ │ │ +  <[ref]use e>
│ │ │ │

│ │ │ │

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]QUOTE TAG [ATTRIBUTE=VALUE ...]>
│ │ │ │ -
│ │ │ │ -name2 ... >
│ │ │ │ -
│ │ │ │ +    a is expanded at time 1.
│ │ │ │ +    b is expanded at time 0.
│ │ │ │ +  contents of a:   a is expanded at time <[ref]use time>.
│ │ │ │ +  contents of b:   b is expanded at time 0.
│ │ │ │ +    c is expanded at time 1;   a is expanded at time 1.
│ │ │ │ +    d is expanded at time 1;   a is expanded at time 2.
│ │ │ │ +    e is expanded at time 2;   a is defined for the 2nd time <[ref]use time>.
│ │ │ │

│ │ │ │

│ │ │ │ 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,80 +1,82 @@ │ │ │ │ │ [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 <_[_[_r_e_f_]_]_I_N_C macroname1="increment1" │ │ │ │ │ -  _L_i_c_e_n_s_e [macroname2="increment2" ... ] [GLOBAL]> │ │ │ │ │ -  _T_u_t_o_r_i_a_l │ │ │ │ │ -  _U_s_a_g_e ********** ssyynnooppssiiss ********** │ │ │ │ │ -  HTP Tags DDEEFF creates _m_e_t_a_t_a_g_s, which is a fancy way of │ │ │ │ │ -    _A_L_T_T_E_X_T saying it creates new tags. The mechanism is very │ │ │ │ │ -    _B_L_O_C_K similar to _B_L_O_C_K macros, except that the _U_S_E tag is │ │ │ │ │ -    _B_L_O_C_K_D_E_F not used to expand them. Instead, they are expanded │ │ │ │ │ -  [>] _D_E_F by their own name. For example: │ │ │ │ │ -    _F_I_L_E   <_[_[_r_e_f_]_]_i_m_a_g_e_u_r_l url="http://my.domain.org/ │ │ │ │ │ -    _I_F " path="/var/www/my.domain/"> │ │ │ │ │ -    _I_N_C   <_[_[_r_e_f_]_]_i_m_a_g_e_u_r_l url="other.domain.org/" path="/ │ │ │ │ │ -    _I_M_G var/www/other.domain/"> │ │ │ │ │ -    _I_M_A_G_E_U_R_L │ │ │ │ │ -    _O_P_T   For this line: <_[_[_r_e_f_]_]_i_m_g src="logo.gif"> │ │ │ │ │ -    _O_U_T_P_U_T   the local filename "logo.gif" will be used to │ │ │ │ │ -    _Q_U_O_T_E determine image dimensions │ │ │ │ │ -    _S_E_T   (no URL replacement). │ │ │ │ │ -    _U_N_D_E_F │ │ │ │ │ -    _U_N_S_E_T   For this line: <_[_[_r_e_f_]_]_i_m_g src="http:// │ │ │ │ │ -    _U_S_E_,_ _$ my.domain.org/logo.gif"> │ │ │ │ │ -    _W_H_I_L_E   the local filename "/var/www/my.domain/logo.gif" │ │ │ │ │ -    _<_!_-_-_- will be used. │ │ │ │ │ -  _H_i_s_t_o_r_y │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t   But for this line: <_[_[_r_e_f_]_]_i_m_g src="http:// │ │ │ │ │ -  _B_u_g_s other.domain.org/logo.gif"> │ │ │ │ │ -   the local file cannot be found (no prefix match), │ │ │ │ │ - so the image dimensions │ │ │ │ │ -   will not be added. │ │ │ │ │ - │ │ │ │ │ -   Order is important; last IMAGEURL tag takes │ │ │ │ │ - precedence: │ │ │ │ │ -   <_[_[_r_e_f_]_]_i_m_a_g_e_u_r_l url="/" path="/var/www/htdocs/"> │ │ │ │ │ -   <_[_[_r_e_f_]_]_i_m_a_g_e_u_r_l url="/test/" path="/var/www/ │ │ │ │ │ - test/"> │ │ │ │ │ - │ │ │ │ │ -   <_[_[_r_e_f_]_]_i_m_g src="/image.gif"> and <_[_[_r_e_f_]_]_i_m_g │ │ │ │ │ - src="/test/image.gif"> are mapped to │ │ │ │ │ -   /var/www/htdocs/image.gif and /var/www/test/ │ │ │ │ │ - image.gif, resp. │ │ │ │ │ -   If the order of the imageurl lines would be │ │ │ │ │ - swapped, the second │ │ │ │ │ -   image would be mapped to /var/www/htdocs/test/ │ │ │ │ │ - image.gif. │ │ │ │ │ - Some metatags will require an opening and closing │ │ │ │ │ - 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_]_]_b_l_o_c_k_d_e_f name="bolditalic"> │ │ │ │ │ -     │ │ │ │ │ -     <_[_[_r_e_f_]_]_u_s_e block> │ │ │ │ │ -     │ │ │ │ │ -   <_[_[_r_e_f_]_]_/_b_l_o_c_k_d_e_f> │ │ │ │ │ - │ │ │ │ │ -   This is bold and italic │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n │ │ │ │ │ +  _T_u_t_o_r_i_a_l ********** ssyynnooppssiiss ********** │ │ │ │ │ +  _U_s_a_g_e DDEEFF creates _m_e_t_a_t_a_g_s, which is a fancy way of │ │ │ │ │ +  HTP Tags saying it creates new tags. The mechanism is very │ │ │ │ │ +    _A_L_T_T_E_X_T similar to _B_L_O_C_K macros, except that the _U_S_E tag is │ │ │ │ │ +    _B_L_O_C_K not used to expand them. Instead, they are expanded │ │ │ │ │ +    _B_L_O_C_K_D_E_F by their own name. For example: │ │ │ │ │ +  [>] _D_E_F     <_[_[_r_e_f_]_]_d_e_f name="centered"> │ │ │ │ │ +    _F_I_L_E    

│ │ │ │ │ +    _I_F     <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ +    _I_N_C │ │ │ │ │ +    _I_M_G     │ │ │ │ │ +    _I_M_A_G_E_U_R_L     This text is centered. │ │ │ │ │ +    _O_P_T Some metatags will require an opening and closing │ │ │ │ │ +    _O_U_T_P_U_T tag (comparable to │ │ │ │ │ +    _Q_U_O_T_E and │ │ │ │ │ +    _S_E_T ). In this case, you should use the _B_L_O_C_K_D_E_F macro. │ │ │ │ │ +    _U_N_D_E_F Another slightly faster alternative is to use two │ │ │ │ │ +    _U_N_S_E_T metatags, the opening tag and the closing tag with │ │ │ │ │ +    _U_S_E_,_ _$ a preceding slash. For example: │ │ │ │ │ +    _W_H_I_L_E   <_[_[_r_e_f_]_]_s_e_t time="0"> │ │ │ │ │ +    _<_!_-_-_-   <_[_[_r_e_f_]_]_b_l_o_c_k name=a> │ │ │ │ │ +  _H_i_s_t_o_r_y     a is expanded at time <_[_[_r_e_f_]_]_u_s_e time>. │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t   <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ +  _B_u_g_s   <_[_[_r_e_f_]_]_b_l_o_c_k name=b expand> │ │ │ │ │ +     b is expanded at time <_[_[_r_e_f_]_]_u_s_e time>. │ │ │ │ │ +   <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ +   <_[_[_r_e_f_]_]_s_e_t time="1"> │ │ │ │ │ +   <_[_[_r_e_f_]_]_u_s_e a> │ │ │ │ │ +   <_[_[_r_e_f_]_]_u_s_e b> │ │ │ │ │ +   contents of a: <_[_[_r_e_f_]_]_u_s_e a noexpand> │ │ │ │ │ +   contents of b: <_[_[_r_e_f_]_]_u_s_e b noexpand> │ │ │ │ │ +   <_[_[_r_e_f_]_]_b_l_o_c_k name=c expand> │ │ │ │ │ +     c is expanded at time <_[_[_r_e_f_]_]_u_s_e time>; <_[ │ │ │ │ │ + _[_r_e_f_]_]_u_s_e a> │ │ │ │ │ +   <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ +   <_[_[_r_e_f_]_]_b_l_o_c_k name=d expand> │ │ │ │ │ +     d is expanded at time <_[_[_r_e_f_]_]_u_s_e time>; <_[ │ │ │ │ │ + _[_r_e_f_]_]_u_s_e a noexpand> │ │ │ │ │ +   <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ +   <_[_[_r_e_f_]_]_b_l_o_c_k name=e> │ │ │ │ │ +     e is expanded at time <_[_[_r_e_f_]_]_u_s_e time>; <_[ │ │ │ │ │ + _[_r_e_f_]_]_u_s_e a noexpand> │ │ │ │ │ +   <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ +   <_[_[_r_e_f_]_]_s_e_t time="2"> │ │ │ │ │ +   <_[_[_r_e_f_]_]_b_l_o_c_k name=a> │ │ │ │ │ +     a is defined for the 2nd time <_[_[_r_e_f_]_]_u_s_e │ │ │ │ │ + time>. │ │ │ │ │ +   <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ +   <_[_[_r_e_f_]_]_u_s_e c> │ │ │ │ │ +   <_[_[_r_e_f_]_]_u_s_e d> │ │ │ │ │ +   <_[_[_r_e_f_]_]_u_s_e e> │ │ │ │ │ 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_]_]_Q_U_O_T_E TAG [ATTRIBUTE=VALUE ...]> │ │ │ │ │ - │ │ │ │ │ - name2 ... > │ │ │ │ │ - │ │ │ │ │ +     a is expanded at time 1. │ │ │ │ │ +     b is expanded at time 0. │ │ │ │ │ +   contents of a:   a is expanded at time <_[ │ │ │ │ │ + _[_r_e_f_]_]_u_s_e time>. │ │ │ │ │ +   contents of b:   b is expanded at time 0. │ │ │ │ │ +     c is expanded at time 1;   a is expanded at │ │ │ │ │ + time 1. │ │ │ │ │ +     d is expanded at time 1;   a is expanded at │ │ │ │ │ + time 2. │ │ │ │ │ +     e is expanded at time 2;   a is defined for the │ │ │ │ │ + 2nd time <_[_[_r_e_f_]_]_u_s_e time>. │ │ │ │ │ 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 │ │ │ ├── ./usr/share/doc/htp/expand.html │ │ │ │ @@ -98,30 +98,27 @@ │ │ │ │

However, if the block tag is marked with the expand │ │ │ │ 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:

│ │ │ │

│ │ │ │ - 1.     <[ref]def name="centered">
│ │ │ │ - 2.     <p align=center>
│ │ │ │ - 3.     <[ref]/def>
│ │ │ │ - 4.
│ │ │ │ - 5.     <centered>
│ │ │ │ - 6.     This text is centered.
│ │ │ │ + 1. <[ref]file execute="command-line" (output="filename" | redirect) [noerror]>
│ │ │ │ + 2. <[ref]file include="includefilename" [parameters ...]>
│ │ │ │ + 3. <[ref]file name>
│ │ │ │ + 4. <[ref]file [ name="filename" ] size[ = (byte|kbyte|mbyte|gbyte) ] [precision=n]>
│ │ │ │ + 5. <[ref]file [ name="filename" ] time[ ="format" ]>
│ │ │ │ + 6. <[ref]file [ name="filename" ] date[ ="format" ]>
│ │ │ │ + 7. <[ref]file search="searchpath">
│ │ │ │ + 8. <[ref]file template="templatefilename">
│ │ │ │ + 9.
│ │ │ │

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

│ │ │ │ -  <[ref]blockdef name="bolditalic">
│ │ │ │ -    <b><i>
│ │ │ │ -    <[ref]use block>
│ │ │ │ -    </i></b>
│ │ │ │ -  <[ref]/blockdef>
│ │ │ │ -
│ │ │ │ -  This is <bolditalic>bold and italic</bolditalic>
│ │ │ │ +    <EM>File "<[ref]FILE NAME>" last updated <[ref]FILE TIME>, <[ref]FILE DATE></EM>
│ │ │ │

│ │ │ │

│ │ │ │ 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 {} │ │ │ │ │ @@ -24,28 +24,31 @@ │ │ │ │ │ However, if the block tag is marked with the expand │ │ │ │ │ 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: │ │ │ │ │ -  1.     <_[_[_r_e_f_]_]_d_e_f name="centered"> │ │ │ │ │ -  2.    

│ │ │ │ │ -  3.     <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ -  4. │ │ │ │ │ -  5.     │ │ │ │ │ -  6.     This text is centered. │ │ │ │ │ +  1. <_[_[_r_e_f_]_]_f_i_l_e execute="command-line" │ │ │ │ │ + (output="filename" | redirect) [noerror]> │ │ │ │ │ +  2. <_[_[_r_e_f_]_]_f_i_l_e include="includefilename" │ │ │ │ │ + [parameters ...]> │ │ │ │ │ +  3. <_[_[_r_e_f_]_]_f_i_l_e name> │ │ │ │ │ +  4. <_[_[_r_e_f_]_]_f_i_l_e [ name="filename" ] size[ = │ │ │ │ │ + (byte|kbyte|mbyte|gbyte) ] [precision=n]> │ │ │ │ │ +  5. <_[_[_r_e_f_]_]_f_i_l_e [ name="filename" ] time │ │ │ │ │ + [ ="format" ]> │ │ │ │ │ +  6. <_[_[_r_e_f_]_]_f_i_l_e [ name="filename" ] date │ │ │ │ │ + [ ="format" ]> │ │ │ │ │ +  7. <_[_[_r_e_f_]_]_f_i_l_e search="searchpath"> │ │ │ │ │ +  8. <_[_[_r_e_f_]_]_f_i_l_e template="templatefilename"> │ │ │ │ │ +  9. │ │ │ │ │ This produces the following: │ │ │ │ │ -   <_[_[_r_e_f_]_]_b_l_o_c_k_d_e_f name="bolditalic"> │ │ │ │ │ -     │ │ │ │ │ -     <_[_[_r_e_f_]_]_u_s_e block> │ │ │ │ │ -     │ │ │ │ │ -   <_[_[_r_e_f_]_]_/_b_l_o_c_k_d_e_f> │ │ │ │ │ - │ │ │ │ │ -   This is bold and italic │ │ │ │ │ +     File "<_[_[_r_e_f_]_]_F_I_L_E NAME>" last updated <_[ │ │ │ │ │ + _[_r_e_f_]_]_F_I_L_E TIME>, <_[_[_r_e_f_]_]_F_I_L_E DATE> │ │ │ │ │ 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,51 +114,53 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ -    <[ref]def name="centered">
│ │ │ │ -    <p align=center>
│ │ │ │ -    <[ref]/def>
│ │ │ │ -
│ │ │ │ -    <centered>
│ │ │ │ -    This text is centered.
│ │ │ │ +    a is expanded at time 1.
│ │ │ │ +    b is expanded at time 0.
│ │ │ │ +  contents of a:   a is expanded at time <[ref]use time>.
│ │ │ │ +  contents of b:   b is expanded at time 0.
│ │ │ │ +    c is expanded at time 1;   a is expanded at time 1.
│ │ │ │ +    d is expanded at time 1;   a is expanded at time 2.
│ │ │ │ +    e is expanded at time 2;   a is defined for the 2nd time <[ref]use time>.
│ │ │ │

│ │ │ │

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. │ │ │ │

│ │ │ │ As with all HTML, these tags do not have to be on their own line, so the │ │ │ │ following is perfectly acceptable: │ │ │ │

│ │ │ │ -<[ref]if disabled_because_xyz>
│ │ │ │ -  ...
│ │ │ │ -<[ref]/if>
│ │ │ │ -expanded at time 0.
│ │ │ │ -  contents of a:   a is expanded at time <[ref]use time>.
│ │ │ │ -  contents of b:   b is expanded at time 0.
│ │ │ │ -    c is expanded at time 1;   a is expanded at time 1.
│ │ │ │ -    d is expanded at time 1;   a is expanded at time 2.
│ │ │ │ -    e is expanded at time 2;   a is defined for the 2nd time <[ref]use time>.
│ │ │ │ +<[ref]IF [NOT] conditional>
│ │ │ │ +    block #1
│ │ │ │ +[
│ │ │ │ +<ELSEIF [NOT] conditional>
│ │ │ │ +    block #2
│ │ │ │ +...
│ │ │ │ +]
│ │ │ │ +[
│ │ │ │ +<ELSE>
│ │ │ │ +    block #3
│ │ │ │ +]
│ │ │ │ +<[ref]/IF>
│ │ │ │ +
│ │ │ │

│ │ │ │

│ │ │ │

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]OUTPUT FILE="outputfilename" [APPEND] [EXPAND]>
│ │ │ │ -text block
│ │ │ │ -<[ref]/OUTPUT>
│ │ │ │ -
│ │ │ │ +    <[ref]IF name="Jim">...<[ref]/IF>
│ │ │ │

│ │ │ │

│ │ │ │ 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 │ │ │ │ @@ -187,19 +189,15 @@ │ │ │ │

│ │ │ │ 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]def name="sharedimg" option="name alt">
│ │ │ │ -    <[ref]img src="/home/sharedimages/${name}" alt="${alt}">;
│ │ │ │ -  <[ref]/def>
│ │ │ │ -
│ │ │ │ -  <sharedimg name="bubble.gif" alt="Bubble image">
│ │ │ │ +    <[ref]INC i="1" j="-1">
│ │ │ │

│ │ │ │

│ │ │ │ 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,48 +1,49 @@ │ │ │ │ │ [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_]_]_d_e_f name="centered"> │ │ │ │ │ -  _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     │ │ │ │ │ -    _A_L_T_T_E_X_T     This text is centered. │ │ │ │ │ -    _B_L_O_C_K ********** ssyynnooppssiiss ********** │ │ │ │ │ -    _B_L_O_C_K_D_E_F FFIILLEE has several optional parameters of differing │ │ │ │ │ -    _D_E_F purpose. The output file's name, the current date │ │ │ │ │ -  [>] _F_I_L_E and time, and the contents of another file may be │ │ │ │ │ -    _I_F included. Another file's time, date, or size may be │ │ │ │ │ -    _I_N_C added to the output file as well. │ │ │ │ │ -    _I_M_G As with all HTML, these tags do not have to be on │ │ │ │ │ -    _I_M_A_G_E_U_R_L their own line, so the following is perfectly │ │ │ │ │ -    _O_P_T acceptable: │ │ │ │ │ -    _O_U_T_P_U_T <_[_[_r_e_f_]_]_i_f disabled_because_xyz> │ │ │ │ │ -    _Q_U_O_T_E   ... │ │ │ │ │ -    _S_E_T <_[_[_r_e_f_]_]_/_i_f> │ │ │ │ │ -    _U_N_D_E_F expanded at time 0. │ │ │ │ │ -    _U_N_S_E_T   contents of a:   a is expanded at time <_[ │ │ │ │ │ -    _U_S_E_,_ _$ _[_r_e_f_]_]_u_s_e time>. │ │ │ │ │ -    _W_H_I_L_E   contents of b:   b is expanded at time 0. │ │ │ │ │ -    _<_!_-_-_-     c is expanded at time 1;   a is expanded at │ │ │ │ │ -  _H_i_s_t_o_r_y time 1. │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t     d is expanded at time 1;   a is expanded at │ │ │ │ │ -  _B_u_g_s time 2. │ │ │ │ │ -     e is expanded at time 2;   a is defined for the │ │ │ │ │ - 2nd time <_[_[_r_e_f_]_]_u_s_e time>. │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n     a is expanded at time 1. │ │ │ │ │ +  _L_i_c_e_n_s_e     b is expanded at time 0. │ │ │ │ │ +  _T_u_t_o_r_i_a_l   contents of a:   a is expanded at time <_[ │ │ │ │ │ +  _U_s_a_g_e _[_r_e_f_]_]_u_s_e time>. │ │ │ │ │ +  HTP Tags   contents of b:   b is expanded at time 0. │ │ │ │ │ +    _A_L_T_T_E_X_T     c is expanded at time 1;   a is expanded at │ │ │ │ │ +    _B_L_O_C_K time 1. │ │ │ │ │ +    _B_L_O_C_K_D_E_F     d is expanded at time 1;   a is expanded at │ │ │ │ │ +    _D_E_F time 2. │ │ │ │ │ +  [>] _F_I_L_E     e is expanded at time 2;   a is defined for the │ │ │ │ │ +    _I_F 2nd time <_[_[_r_e_f_]_]_u_s_e time>. │ │ │ │ │ +    _I_N_C ********** ssyynnooppssiiss ********** │ │ │ │ │ +    _I_M_G FFIILLEE has several optional parameters of differing │ │ │ │ │ +    _I_M_A_G_E_U_R_L purpose. The output file's name, the current date │ │ │ │ │ +    _O_P_T and time, and the contents of another file may be │ │ │ │ │ +    _O_U_T_P_U_T included. Another file's time, date, or size may be │ │ │ │ │ +    _Q_U_O_T_E added to the output file as well. │ │ │ │ │ +    _S_E_T As with all HTML, these tags do not have to be on │ │ │ │ │ +    _U_N_D_E_F their own line, so the following is perfectly │ │ │ │ │ +    _U_N_S_E_T acceptable: │ │ │ │ │ +    _U_S_E_,_ _$ <_[_[_r_e_f_]_]_I_F [NOT] conditional> │ │ │ │ │ +    _W_H_I_L_E     block #1 │ │ │ │ │ +    _<_!_-_-_- [ │ │ │ │ │ +  _H_i_s_t_o_r_y │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t     block #2 │ │ │ │ │ +  _B_u_g_s ... │ │ │ │ │ + ] │ │ │ │ │ + [ │ │ │ │ │ + │ │ │ │ │ +     block #3 │ │ │ │ │ + ] │ │ │ │ │ + <_[_[_r_e_f_]_]_/_I_F> │ │ │ │ │ + │ │ │ │ │ ******** NNAAMMEE,, TTIIMMEE,, SSIIZZEE ******** │ │ │ │ │ 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: │ │ │ │ │ - <_[_[_r_e_f_]_]_O_U_T_P_U_T FILE="outputfilename" [APPEND] │ │ │ │ │ - [EXPAND]> │ │ │ │ │ - text block │ │ │ │ │ - <_[_[_r_e_f_]_]_/_O_U_T_P_U_T> │ │ │ │ │ - │ │ │ │ │ +     <_[_[_r_e_f_]_]_I_F name="Jim">...<_[_[_r_e_f_]_]_/_I_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 │ │ │ │ │ @@ -73,20 +74,15 @@ │ │ │ │ │ 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_]_]_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> │ │ │ │ │ - │ │ │ │ │ -   │ │ │ │ │ +     <_[_[_r_e_f_]_]_I_N_C i="1" j="-1"> │ │ │ │ │ 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 │ │ │ │ @@ -114,37 +114,32 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ -    <[ref]def name="centered">
│ │ │ │ -    <p align=center>
│ │ │ │ -    <[ref]/def>
│ │ │ │ +<[ref]img src="filename" ...>
│ │ │ │
│ │ │ │ -    <centered>
│ │ │ │ -    This text is centered.
│ │ │ │

│ │ │ │

synopsis

│ │ │ │ IF, NOT, ELSEIF, ELSE, and /IF are the building │ │ │ │ blocks for conditional 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: │ │ │ │

│ │ │ │ -    <[ref]INC i="1" j="-1">
│ │ │ │ +<[ref]imageurl url="imageurl" [ path="path/in/local/filesystem" ]>
│ │ │ │ +
│ │ │ │

│ │ │ │

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

│ │ │ │

│ │ │ │ -<[ref]OUTPUT FILE="outputfilename" [APPEND] [EXPAND]>
│ │ │ │ -text block
│ │ │ │ -<[ref]/OUTPUT>
│ │ │ │ +<[ref]INC macroname1="increment1" [macroname2="increment2" ... ] [GLOBAL]>
│ │ │ │
│ │ │ │

│ │ │ │

│ │ │ │ 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 │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,40 +1,36 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: IIFF,, EELLSSEEIIFF,, EELLSSEE,, //IIFF ************ │ │ │ │ │ _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_]_]_d_e_f name="centered"> │ │ │ │ │ -  _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     │ │ │ │ │ -    _A_L_T_T_E_X_T     This text is centered. │ │ │ │ │ -    _B_L_O_C_K ********** ssyynnooppssiiss ********** │ │ │ │ │ -    _B_L_O_C_K_D_E_F IIFF,, NNOOTT,, EELLSSEEIIFF,, EELLSSEE,, aanndd //IIFF are the building │ │ │ │ │ -    _D_E_F blocks for conditional processing. The basic form │ │ │ │ │ -    _F_I_L_E is shown above. │ │ │ │ │ -  [>] _I_F "Conditional" is either a "compare" or "is defined" │ │ │ │ │ -    _I_N_C operation. A compare operator is a test of the │ │ │ │ │ -    _I_M_G value of a macro against a literal string: │ │ │ │ │ -    _I_M_A_G_E_U_R_L     <_[_[_r_e_f_]_]_I_N_C i="1" j="-1"> │ │ │ │ │ -    _O_P_T and a defined operator is a test of a macro's │ │ │ │ │ -    _O_U_T_P_U_T existance: │ │ │ │ │ -    _Q_U_O_T_E <_[_[_r_e_f_]_]_O_U_T_P_U_T FILE="outputfilename" [APPEND] │ │ │ │ │ -    _S_E_T [EXPAND]> │ │ │ │ │ -    _U_N_D_E_F text block │ │ │ │ │ -    _U_N_S_E_T <_[_[_r_e_f_]_]_/_O_U_T_P_U_T> │ │ │ │ │ -    _U_S_E_,_ _$ │ │ │ │ │ -    _W_H_I_L_E If the NOT tag is present in the IF markup, the │ │ │ │ │ -    _<_!_-_-_- evaluation of the conditional is reversed. The │ │ │ │ │ -  _H_i_s_t_o_r_y first IF or ELSEIF condition that evaluates to true │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t is chosen. If none of the conditions is true the │ │ │ │ │ -  _B_u_g_s ELSE block is taken if it is present. A conditional │ │ │ │ │ - block mmuusstt be closed with the /IF tag. IF tags can │ │ │ │ │ - be nested. │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n <_[_[_r_e_f_]_]_i_m_g src="filename" ...> │ │ │ │ │ +  _L_i_c_e_n_s_e │ │ │ │ │ +  _T_u_t_o_r_i_a_l ********** ssyynnooppssiiss ********** │ │ │ │ │ +  _U_s_a_g_e IIFF,, NNOOTT,, EELLSSEEIIFF,, EELLSSEE,, aanndd //IIFF are the building │ │ │ │ │ +  HTP Tags blocks for conditional processing. The basic form │ │ │ │ │ +    _A_L_T_T_E_X_T is shown above. │ │ │ │ │ +    _B_L_O_C_K "Conditional" is either a "compare" or "is defined" │ │ │ │ │ +    _B_L_O_C_K_D_E_F operation. A compare operator is a test of the │ │ │ │ │ +    _D_E_F value of a macro against a literal string: │ │ │ │ │ +    _F_I_L_E <_[_[_r_e_f_]_]_i_m_a_g_e_u_r_l url="imageurl" [ path="path/in/ │ │ │ │ │ +  [>] _I_F local/filesystem" ]> │ │ │ │ │ +    _I_N_C │ │ │ │ │ +    _I_M_G and a defined operator is a test of a macro's │ │ │ │ │ +    _I_M_A_G_E_U_R_L existance: │ │ │ │ │ +    _O_P_T <_[_[_r_e_f_]_]_I_N_C macroname1="increment1" │ │ │ │ │ +    _O_U_T_P_U_T [macroname2="increment2" ... ] [GLOBAL]> │ │ │ │ │ +    _Q_U_O_T_E │ │ │ │ │ +    _S_E_T If the NOT tag is present in the IF markup, the │ │ │ │ │ +    _U_N_D_E_F evaluation of the conditional is reversed. The │ │ │ │ │ +    _U_N_S_E_T first IF or ELSEIF condition that evaluates to true │ │ │ │ │ +    _U_S_E_,_ _$ is chosen. If none of the conditions is true the │ │ │ │ │ +    _W_H_I_L_E ELSE block is taken if it is present. A conditional │ │ │ │ │ +    _<_!_-_-_- block mmuusstt be closed with the /IF tag. IF tags can │ │ │ │ │ +  _H_i_s_t_o_r_y be nested. │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t │ │ │ │ │ +  _B_u_g_s │ │ │ ├── ./usr/share/doc/htp/imageurl.html │ │ │ │ @@ -114,15 +114,16 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ -<!--- This comment doesn't appear in the HTML file --->
│ │ │ │ +    <[ref]FILE INCLUDE="include.hti" name="Jim Nelson" email="jnelson@crl.com">
│ │ │ │ +    This tag will fail: <[ref]USE name>
│ │ │ │

│ │ │ │

synopsis

│ │ │ │

│ │ │ │ IMAGEURL tells htp, where to find images on the local │ │ │ │ file system. declares an URL replacement that is used for │ │ │ │ size lookups in any IMG tag. This definitions │ │ │ │ takes effect only if the IMGXY option is │ │ │ │ @@ -136,22 +137,15 @@ │ │ │ │ checks (case-insensitive) if it is a prefix of the image's SRC │ │ │ │ attribute. If it matches this prefix is replaced by the given PATH. │ │ │ │ If no IMAGEURL matches the SRC is considered as relative link and │ │ │ │ looked up in the current directory.

│ │ │ │

│ │ │ │ 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)>
│ │ │ │ -
│ │ │ │ +    <[ref]INC i="1" j="-1">
│ │ │ │

│ │ │ │

│ │ │ │ If IMAGEURL is specified with a URL but no PATH attribute, it is treated as │ │ │ │ an undefine, and is removed.

│ │ │ │

│ │ │ │ Since you usually need the url mapping for a number of images used throughout │ │ │ │ a set of documents, IMAGEURL is most appropriately put into an │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,42 +1,36 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: IIMMAAGGEEUURRLL ************ │ │ │ │ │ _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 │ │ │ │ │ -  _T_u_t_o_r_i_a_l ********** ssyynnooppssiiss ********** │ │ │ │ │ -  _U_s_a_g_e IIMMAAGGEEUURRLL tells htp, where to find images on the │ │ │ │ │ -  HTP Tags local file system. declares an URL replacement that │ │ │ │ │ -    _A_L_T_T_E_X_T is used for size lookups in any _I_M_G tag. This │ │ │ │ │ -    _B_L_O_C_K definitions takes effect only if the _I_M_G_X_Y option │ │ │ │ │ -    _B_L_O_C_K_D_E_F is enabled. Beacause htp can't lookup files in the │ │ │ │ │ -    _D_E_F world wide web you have to map absolute image URLs │ │ │ │ │ -    _F_I_L_E to a directory in the local file system. │ │ │ │ │ -    _I_F When an IMG tag is encountered where htp has to │ │ │ │ │ -    _I_N_C insert width and height the defined URL │ │ │ │ │ -    _I_M_G replacements will be taken into account (later │ │ │ │ │ -  [>] _I_M_A_G_E_U_R_L definitions take precedence to earlier): For each │ │ │ │ │ -    _O_P_T defined imageurl it checks (case-insensitive) if it │ │ │ │ │ -    _O_U_T_P_U_T is a prefix of the image's SRC attribute. If it │ │ │ │ │ -    _Q_U_O_T_E matches this prefix is replaced by the given PATH. │ │ │ │ │ -    _S_E_T If no IMAGEURL matches the SRC is considered as │ │ │ │ │ -    _U_N_D_E_F relative link and looked up in the current │ │ │ │ │ -    _U_N_S_E_T directory. │ │ │ │ │ -    _U_S_E_,_ _$ For example: │ │ │ │ │ -    _W_H_I_L_E <_[_[_r_e_f_]_]_O_P_T (IMGXY|NOIMGXY)> │ │ │ │ │ -    _<_!_-_-_- <_[_[_r_e_f_]_]_O_P_T (QUIET|VERBOSE)> │ │ │ │ │ -  _H_i_s_t_o_r_y <_[_[_r_e_f_]_]_O_P_T (DEPEND|NODEPEND)> │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t <_[_[_r_e_f_]_]_O_P_T (PRECIOUS|NOPRECIOUS)> │ │ │ │ │ -  _B_u_g_s <_[_[_r_e_f_]_]_O_P_T (CONDENSE|SEMICONDENSE|NOCONDENSE)> │ │ │ │ │ - <_[_[_r_e_f_]_]_O_P_T DELIM=(HTML|SQUARE|CURLY)> │ │ │ │ │ - <_[_[_r_e_f_]_]_O_P_T (XML|XML=FALSE)> │ │ │ │ │ - │ │ │ │ │ - If IMAGEURL is specified with a URL but no PATH │ │ │ │ │ - attribute, it is treated as an undefine, and is │ │ │ │ │ - removed. │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n     <_[_[_r_e_f_]_]_F_I_L_E INCLUDE="include.hti" name="Jim │ │ │ │ │ +  _L_i_c_e_n_s_e Nelson" email="jnelson@crl.com"> │ │ │ │ │ +  _T_u_t_o_r_i_a_l     This tag will fail: <_[_[_r_e_f_]_]_U_S_E name> │ │ │ │ │ +  _U_s_a_g_e ********** ssyynnooppssiiss ********** │ │ │ │ │ +  HTP Tags IIMMAAGGEEUURRLL tells htp, where to find images on the │ │ │ │ │ +    _A_L_T_T_E_X_T local file system. declares an URL replacement that │ │ │ │ │ +    _B_L_O_C_K is used for size lookups in any _I_M_G tag. This │ │ │ │ │ +    _B_L_O_C_K_D_E_F definitions takes effect only if the _I_M_G_X_Y option │ │ │ │ │ +    _D_E_F is enabled. Beacause htp can't lookup files in the │ │ │ │ │ +    _F_I_L_E world wide web you have to map absolute image URLs │ │ │ │ │ +    _I_F to a directory in the local file system. │ │ │ │ │ +    _I_N_C When an IMG tag is encountered where htp has to │ │ │ │ │ +    _I_M_G insert width and height the defined URL │ │ │ │ │ +  [>] _I_M_A_G_E_U_R_L replacements will be taken into account (later │ │ │ │ │ +    _O_P_T definitions take precedence to earlier): For each │ │ │ │ │ +    _O_U_T_P_U_T defined imageurl it checks (case-insensitive) if it │ │ │ │ │ +    _Q_U_O_T_E is a prefix of the image's SRC attribute. If it │ │ │ │ │ +    _S_E_T matches this prefix is replaced by the given PATH. │ │ │ │ │ +    _U_N_D_E_F If no IMAGEURL matches the SRC is considered as │ │ │ │ │ +    _U_N_S_E_T relative link and looked up in the current │ │ │ │ │ +    _U_S_E_,_ _$ directory. │ │ │ │ │ +    _W_H_I_L_E For example: │ │ │ │ │ +    _<_!_-_-_-     <_[_[_r_e_f_]_]_I_N_C i="1" j="-1"> │ │ │ │ │ +  _H_i_s_t_o_r_y If IMAGEURL is specified with a URL but no PATH │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t attribute, it is treated as an undefine, and is │ │ │ │ │ +  _B_u_g_s removed. │ │ │ │ │ Since you usually need the url mapping for a number │ │ │ │ │ of images used throughout a set of documents, │ │ │ │ │ IMAGEURL is most appropriately put into an _i_n_c_l_u_d_e │ │ │ │ │ _f_i_l_e or the _h_t_p_._d_e_f file. │ │ │ │ │ In addition to WIDTH and HEIGHT, htp can also │ │ │ │ │ (semi-)automatically add an _A_L_T_ _t_e_x_t attribute to │ │ │ │ │ _I_M_G tags. │ │ │ ├── ./usr/share/doc/htp/img.html │ │ │ │ @@ -114,20 +114,15 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ -    <[ref]def name="centered">
│ │ │ │ -    <p align=center>
│ │ │ │ -    <[ref]/def>
│ │ │ │ -
│ │ │ │ -    <centered>
│ │ │ │ -    This text is centered.
│ │ │ │ +    <[ref]IF name="Jim">...<[ref]/IF>
│ │ │ │

│ │ │ │

synopsis

│ │ │ │

img is a standard HTML tag. htp can add the specified │ │ │ │ image's width and height to the tag automatically. This has the advantage │ │ │ │ of not having to determine each image's size manually, which is especially │ │ │ │ useful if the image may change frequently.

│ │ │ │

htp adds this information with the WIDTH and HEIGHT markup │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,41 +1,36 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: IIMMGG ************ │ │ │ │ │ _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_]_]_d_e_f name="centered"> │ │ │ │ │ -  _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     │ │ │ │ │ -    _A_L_T_T_E_X_T     This text is centered. │ │ │ │ │ -    _B_L_O_C_K ********** ssyynnooppssiiss ********** │ │ │ │ │ -    _B_L_O_C_K_D_E_F iimmgg is a standard HTML tag. htp can add the │ │ │ │ │ -    _D_E_F specified image's width and height to the tag │ │ │ │ │ -    _F_I_L_E automatically. This has the advantage of not having │ │ │ │ │ -    _I_F to determine each image's size manually, which is │ │ │ │ │ -    _I_N_C especially useful if the image may change │ │ │ │ │ -  [>] _I_M_G frequently. │ │ │ │ │ -    _I_M_A_G_E_U_R_L htp adds this information with the WIDTH and HEIGHT │ │ │ │ │ -    _O_P_T markup attributes. If htp detects these attributes │ │ │ │ │ -    _O_U_T_P_U_T are already present in the tag, it will nnoott modify │ │ │ │ │ -    _Q_U_O_T_E the values. If htp cannot find the image file, it │ │ │ │ │ -    _S_E_T will issue a warning but not halt processing. │ │ │ │ │ -    _U_N_D_E_F At this time, GIF (Graphic Interchange Format), PNG │ │ │ │ │ -    _U_N_S_E_T (Portable Network Graphics), and JFIF (JPEG File │ │ │ │ │ -    _U_S_E_,_ _$ Interchange Format) are supported. │ │ │ │ │ -    _W_H_I_L_E The _I_M_G_X_Y_ _a_n_d_ _N_O_I_M_G_X_Y options control whether or │ │ │ │ │ -    _<_!_-_-_- not htp actually adds this information as it │ │ │ │ │ -  _H_i_s_t_o_r_y executes. │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t Since htp is able to lookup files only in the local │ │ │ │ │ -  _B_u_g_s filesystem, the _I_M_A_G_E_U_R_L tag may be used to map │ │ │ │ │ - URLs to local files. │ │ │ │ │ - htp can also add default ALT text to IMG tags using │ │ │ │ │ - _A_L_T_T_E_X_T. │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n     <_[_[_r_e_f_]_]_I_F name="Jim">...<_[_[_r_e_f_]_]_/_I_F> │ │ │ │ │ +  _L_i_c_e_n_s_e ********** ssyynnooppssiiss ********** │ │ │ │ │ +  _T_u_t_o_r_i_a_l iimmgg is a standard HTML tag. htp can add the │ │ │ │ │ +  _U_s_a_g_e specified image's width and height to the tag │ │ │ │ │ +  HTP Tags automatically. This has the advantage of not having │ │ │ │ │ +    _A_L_T_T_E_X_T to determine each image's size manually, which is │ │ │ │ │ +    _B_L_O_C_K especially useful if the image may change │ │ │ │ │ +    _B_L_O_C_K_D_E_F frequently. │ │ │ │ │ +    _D_E_F htp adds this information with the WIDTH and HEIGHT │ │ │ │ │ +    _F_I_L_E markup attributes. If htp detects these attributes │ │ │ │ │ +    _I_F are already present in the tag, it will nnoott modify │ │ │ │ │ +    _I_N_C the values. If htp cannot find the image file, it │ │ │ │ │ +  [>] _I_M_G will issue a warning but not halt processing. │ │ │ │ │ +    _I_M_A_G_E_U_R_L At this time, GIF (Graphic Interchange Format), PNG │ │ │ │ │ +    _O_P_T (Portable Network Graphics), and JFIF (JPEG File │ │ │ │ │ +    _O_U_T_P_U_T Interchange Format) are supported. │ │ │ │ │ +    _Q_U_O_T_E The _I_M_G_X_Y_ _a_n_d_ _N_O_I_M_G_X_Y options control whether or │ │ │ │ │ +    _S_E_T not htp actually adds this information as it │ │ │ │ │ +    _U_N_D_E_F executes. │ │ │ │ │ +    _U_N_S_E_T Since htp is able to lookup files only in the local │ │ │ │ │ +    _U_S_E_,_ _$ filesystem, the _I_M_A_G_E_U_R_L tag may be used to map │ │ │ │ │ +    _W_H_I_L_E URLs to local files. │ │ │ │ │ +    _<_!_-_-_- htp can also add default ALT text to IMG tags using │ │ │ │ │ +  _H_i_s_t_o_r_y _A_L_T_T_E_X_T. │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t │ │ │ │ │ +  _B_u_g_s │ │ │ ├── ./usr/share/doc/htp/inc.html │ │ │ │ @@ -114,57 +114,31 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ -  <[ref]imageurl url="http://my.domain.org/" path="/var/www/my.domain/">
│ │ │ │ -  <[ref]imageurl url="other.domain.org/" path="/var/www/other.domain/">
│ │ │ │ +<[ref]INC macroname1="increment1" [macroname2="increment2" ... ] [GLOBAL]>
│ │ │ │
│ │ │ │ -  For this line: <[ref]img src="logo.gif">
│ │ │ │ -  the local filename "logo.gif" will be used to determine image dimensions
│ │ │ │ -  (no URL replacement).
│ │ │ │ -
│ │ │ │ -  For this line: <[ref]img src="http://my.domain.org/logo.gif">
│ │ │ │ -  the local filename "/var/www/my.domain/logo.gif" will be used.
│ │ │ │ -
│ │ │ │ -  But for this line: <[ref]img src="http://other.domain.org/logo.gif">
│ │ │ │ -  the local file cannot be found (no prefix match), so the image dimensions
│ │ │ │ -  will not be added.
│ │ │ │ -
│ │ │ │ -  Order is important; last IMAGEURL tag takes precedence:
│ │ │ │ -  <[ref]imageurl url="/" path="/var/www/htdocs/">
│ │ │ │ -  <[ref]imageurl url="/test/" path="/var/www/test/">
│ │ │ │ -
│ │ │ │ -  <[ref]img src="/image.gif"> and <[ref]img src="/test/image.gif"> are mapped to
│ │ │ │ -  /var/www/htdocs/image.gif and /var/www/test/image.gif, resp.
│ │ │ │ -  If the order of the imageurl lines would be swapped, the second
│ │ │ │ -  image would be mapped to /var/www/htdocs/test/image.gif.
│ │ │ │

│ │ │ │

synopsis

│ │ │ │ The INC can be used for incrementing/decrementing a │ │ │ │ variable or for variable addition. The basic form is shown above. │ │ │ │

│ │ │ │ The "increment" is anything that evaluates to a integer. It can be a │ │ │ │ literal string or a macro preceeded by the '$'-operator. The │ │ │ │ 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]blockdef name="bolditalic">
│ │ │ │ -    <b><i>
│ │ │ │ -    <[ref]use block>
│ │ │ │ -    </i></b>
│ │ │ │ -  <[ref]/blockdef>
│ │ │ │ -
│ │ │ │ -  This is <bolditalic>bold and italic</bolditalic>
│ │ │ │ +    <[ref]INC i="1" j="-1">
│ │ │ │

│ │ │ │

│ │ │ │ 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 {} │ │ │ │ │ @@ -1,74 +1,36 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: IINNCC ************ │ │ │ │ │ _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_]_]_i_m_a_g_e_u_r_l url="http://my.domain.org/ │ │ │ │ │ -  _L_i_c_e_n_s_e " path="/var/www/my.domain/"> │ │ │ │ │ -  _T_u_t_o_r_i_a_l   <_[_[_r_e_f_]_]_i_m_a_g_e_u_r_l url="other.domain.org/" path="/ │ │ │ │ │ -  _U_s_a_g_e var/www/other.domain/"> │ │ │ │ │ -  HTP Tags │ │ │ │ │ -    _A_L_T_T_E_X_T   For this line: <_[_[_r_e_f_]_]_i_m_g src="logo.gif"> │ │ │ │ │ -    _B_L_O_C_K   the local filename "logo.gif" will be used to │ │ │ │ │ -    _B_L_O_C_K_D_E_F determine image dimensions │ │ │ │ │ -    _D_E_F   (no URL replacement). │ │ │ │ │ -    _F_I_L_E │ │ │ │ │ -    _I_F   For this line: <_[_[_r_e_f_]_]_i_m_g src="http:// │ │ │ │ │ -  [>] _I_N_C my.domain.org/logo.gif"> │ │ │ │ │ -    _I_M_G   the local filename "/var/www/my.domain/logo.gif" │ │ │ │ │ -    _I_M_A_G_E_U_R_L will be used. │ │ │ │ │ -    _O_P_T │ │ │ │ │ -    _O_U_T_P_U_T   But for this line: <_[_[_r_e_f_]_]_i_m_g src="http:// │ │ │ │ │ -    _Q_U_O_T_E other.domain.org/logo.gif"> │ │ │ │ │ -    _S_E_T   the local file cannot be found (no prefix match), │ │ │ │ │ -    _U_N_D_E_F so the image dimensions │ │ │ │ │ -    _U_N_S_E_T   will not be added. │ │ │ │ │ -    _U_S_E_,_ _$ │ │ │ │ │ -    _W_H_I_L_E   Order is important; last IMAGEURL tag takes │ │ │ │ │ -    _<_!_-_-_- precedence: │ │ │ │ │ -  _H_i_s_t_o_r_y   <_[_[_r_e_f_]_]_i_m_a_g_e_u_r_l url="/" path="/var/www/htdocs/"> │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t   <_[_[_r_e_f_]_]_i_m_a_g_e_u_r_l url="/test/" path="/var/www/ │ │ │ │ │ -  _B_u_g_s test/"> │ │ │ │ │ - │ │ │ │ │ -   <_[_[_r_e_f_]_]_i_m_g src="/image.gif"> and <_[_[_r_e_f_]_]_i_m_g │ │ │ │ │ - src="/test/image.gif"> are mapped to │ │ │ │ │ -   /var/www/htdocs/image.gif and /var/www/test/ │ │ │ │ │ - image.gif, resp. │ │ │ │ │ -   If the order of the imageurl lines would be │ │ │ │ │ - swapped, the second │ │ │ │ │ -   image would be mapped to /var/www/htdocs/test/ │ │ │ │ │ - image.gif. │ │ │ │ │ - ********** ssyynnooppssiiss ********** │ │ │ │ │ - The IINNCC can be used for incrementing/decrementing a │ │ │ │ │ - variable or for variable addition. The basic form │ │ │ │ │ - is shown above. │ │ │ │ │ - The "increment" is anything that evaluates to a │ │ │ │ │ - integer. It can be a literal string or a macro │ │ │ │ │ - preceeded by the '$'-operator. The 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: │ │ │ │ │ -   <_[_[_r_e_f_]_]_b_l_o_c_k_d_e_f name="bolditalic"> │ │ │ │ │ -     │ │ │ │ │ -     <_[_[_r_e_f_]_]_u_s_e block> │ │ │ │ │ -     │ │ │ │ │ -   <_[_[_r_e_f_]_]_/_b_l_o_c_k_d_e_f> │ │ │ │ │ - │ │ │ │ │ -   This is bold and italic │ │ │ │ │ - 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. The INC tag is useful in │ │ │ │ │ - conjunction with WHILE to iterate over the defined │ │ │ │ │ - blocks. │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n <_[_[_r_e_f_]_]_I_N_C macroname1="increment1" │ │ │ │ │ +  _L_i_c_e_n_s_e [macroname2="increment2" ... ] [GLOBAL]> │ │ │ │ │ +  _T_u_t_o_r_i_a_l │ │ │ │ │ +  _U_s_a_g_e ********** ssyynnooppssiiss ********** │ │ │ │ │ +  HTP Tags The IINNCC can be used for incrementing/decrementing a │ │ │ │ │ +    _A_L_T_T_E_X_T variable or for variable addition. The basic form │ │ │ │ │ +    _B_L_O_C_K is shown above. │ │ │ │ │ +    _B_L_O_C_K_D_E_F The "increment" is anything that evaluates to a │ │ │ │ │ +    _D_E_F integer. It can be a literal string or a macro │ │ │ │ │ +    _F_I_L_E preceeded by the '$'-operator. The macroname must │ │ │ │ │ +    _I_F be the name of a defined macro that contains an │ │ │ │ │ +  [>] _I_N_C integer. If the increment is ommitted it defaults │ │ │ │ │ +    _I_M_G to 1. The effect of this operation is that the │ │ │ │ │ +    _I_M_A_G_E_U_R_L macro is redefined to contain the sum of its │ │ │ │ │ +    _O_P_T previous value and its increment. │ │ │ │ │ +    _O_U_T_P_U_T To increment or decrement a variable you can use │ │ │ │ │ +    _Q_U_O_T_E this form: │ │ │ │ │ +    _S_E_T     <_[_[_r_e_f_]_]_I_N_C i="1" j="-1"> │ │ │ │ │ +    _U_N_D_E_F Note that INC doesn't check if the strings really │ │ │ │ │ +    _U_N_S_E_T denote integers. It may give weired results when │ │ │ │ │ +    _U_S_E_,_ _$ used on arbitrary strings. The integer values are │ │ │ │ │ +    _W_H_I_L_E limited to the range -2^31..2^31. │ │ │ │ │ +    _<_!_-_-_- Note further that htp wasn't designed to do │ │ │ │ │ +  _H_i_s_t_o_r_y extensive calculations. The INC tag is useful in │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t conjunction with WHILE to iterate over the defined │ │ │ │ │ +  _B_u_g_s blocks. │ │ │ ├── ./usr/share/doc/htp/metatag.html │ │ │ │ @@ -88,14 +88,27 @@ │ │ │ │

Metatags are defined with the [ref]def and [ref]blockdef tags and │ │ │ │ undefined with the [ref]undef tag.

│ │ │ │

│ │ │ │ As an example we show how to define a tag that builds a │ │ │ │ fancy horizontal rule out of several images. │ │ │ │

│ │ │ │

│ │ │ │ + 1.  <[ref]def name="imghr">
│ │ │ │ + 2.    <table border="0" cellspacing="0" cellpadding="0">
│ │ │ │ + 3.    <tr>
│ │ │ │ + 4.     <td width=10><[ref]img src="leftsep.png"></td>
│ │ │ │ + 5.     <td width="95%" background="midsep.png">&nbsp;</td>
│ │ │ │ + 6.     <td width=10><[ref]img src="rightsep.png"></td>
│ │ │ │ + 7.    </tr>
│ │ │ │ + 8.    </table>
│ │ │ │ + 9.  <[ref]/def>
│ │ │ │ +10.
│ │ │ │ +11.  paragraph
│ │ │ │ +12.  <imghr>
│ │ │ │ +13.  paragraph
│ │ │ │

│ │ │ │

In line 1 of the above example a new tag named imghr is defined. │ │ │ │ The html code which implements this rule is following in lines 2-8. │ │ │ │ between the [ref]def and │ │ │ │ /def tags. You don't have to understand this │ │ │ │ html code, but you should understand that this is just pure html to │ │ │ │ draw the fancy rule. Every time you write <imghr> │ │ │ │ @@ -105,43 +118,50 @@ │ │ │ │ file.

│ │ │ │

Often you want to define tags that have an opening and a closing │ │ │ │ variant. For this purpose you should use the [ref]blockdef tag. When htp │ │ │ │ encounters a blockdef tag it will automatically search for the │ │ │ │ matching closing tag and put everything between these tags in a block │ │ │ │ macro named block. Here is an example for this.

│ │ │ │

│ │ │ │ - 1. <[ref]UNDEF tagname>
│ │ │ │ - 2. <[ref]UNDEF tagname1 tagname2 ... >
│ │ │ │ - 3.
│ │ │ │ + 1. <[ref]OPT (IMGXY|NOIMGXY)>
│ │ │ │ + 2. <[ref]OPT (QUIET|VERBOSE)>
│ │ │ │ + 3. <[ref]OPT (DEPEND|NODEPEND)>
│ │ │ │ + 4. <[ref]OPT (PRECIOUS|NOPRECIOUS)>
│ │ │ │ + 5. <[ref]OPT (CONDENSE|SEMICONDENSE|NOCONDENSE)>
│ │ │ │ + 6. <[ref]OPT DELIM=(HTML|SQUARE|CURLY)>
│ │ │ │ + 7. <[ref]OPT (XML|XML=FALSE)>
│ │ │ │ + 8.
│ │ │ │

│ │ │ │

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]SET emailaddr="jnelson@crl.com">
│ │ │ │ + 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">
│ │ │ │

│ │ │ │

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 │ │ │ │ do this:

│ │ │ │

│ │ │ │ - 1. <[ref]block stuff>
│ │ │ │ - 2.   <a href=$email>send email</a>
│ │ │ │ - 3. <[ref]/block>
│ │ │ │ - 4.
│ │ │ │ - 5. <[ref]set morestuff=$email>
│ │ │ │ - 6.
│ │ │ │ - 7. This works:     <[ref]use stuff email="jnelson@crl.com">
│ │ │ │ - 8. But this fails: <[ref]use email>
│ │ │ │ - 9. And this fails: <[ref]use morestuff email="jnelson@crl.com">
│ │ │ │ + 1.   <[ref]set sect-ctr="0">
│ │ │ │ + 2.   <[ref]blockdef name="section">
│ │ │ │ + 3.     <[ref]inc sect-ctr>
│ │ │ │ + 4.     <[ref]block name="sect-${sect-ctr}" expand global>
│ │ │ │ + 5.       <[ref]use block noexpand>
│ │ │ │ + 6.     <[ref]/block>
│ │ │ │ + 7.   <[ref]/blockdef>
│ │ │ │

│ │ │ │

This defines a block macro named section. This macro uses a │ │ │ │ counter sect-ctr that enumerates the sections. It is │ │ │ │ increased for every section (line 3) and then the block macro name is │ │ │ │ build from this counter. So the first section is stored in block │ │ │ │ sect-1, the second in sect-2 and so on. The [ref]global flag │ │ │ │ in line 4 tells htp that these macros should be defined globally │ │ │ │ @@ -160,16 +180,21 @@ │ │ │ │ contents of block to be expanded twice. If you omit it, it would be │ │ │ │ expanded when defining the sect-1 macro and when using it later in the │ │ │ │ template. Generally it is a good idea to use noexpand whenever you │ │ │ │ use expand in a block around it.

│ │ │ │

To close this example we show how to expand the │ │ │ │ sect-${sect-ctr} blocks in the template:

│ │ │ │

│ │ │ │ - 1. <a href="mailto:$email">mailto hyperlink</a>
│ │ │ │ - 2. <a href="http://$domain/~${username}/">another hyperlink</a>
│ │ │ │ + 1. <[ref]file include="header.hti">
│ │ │ │ + 2.   <[ref]set sect-ctr="1">
│ │ │ │ + 3.   <[ref]while sect-${sect-ctr}>
│ │ │ │ + 4.     <[ref]use sect-${sect-ctr}>
│ │ │ │ + 5.     <[ref]inc sect-ctr>
│ │ │ │ + 6.   <[ref]/while>
│ │ │ │ + 7. <[ref]file include="footer.hti">
│ │ │ │

│ │ │ │

│ │ │ │ The [ref]while tag in line 3 checks whether │ │ │ │ the macro sect-${sect-ctr} is defined. If it is defined the body is │ │ │ │ evaluated, which expands the macro and increases sect-ctr. Afterwards │ │ │ │ the while condition is checked again to check for sect-2 macro. This │ │ │ │ repeats until sect-${sect-ctr} is not defined. │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -9,15 +9,32 @@ │ │ │ │ │     _T_e_m_p_l_a_t_e_s functionality. │ │ │ │ │     _F_i_l_e_s Metatags are defined with the _[_[_r_e_f_]_]_d_e_f and _[ │ │ │ │ │   [>] _M_e_t_a_t_a_g_s _[_r_e_f_]_]_b_l_o_c_k_d_e_f tags and undefined with the _[ │ │ │ │ │   _U_s_a_g_e _[_r_e_f_]_]_u_n_d_e_f tag. │ │ │ │ │   _H_T_P_ _T_a_g_s As an example we show how to define a tag that │ │ │ │ │   _H_i_s_t_o_r_y builds a fancy horizontal rule out of several │ │ │ │ │   _W_i_s_h_ _l_i_s_t images. │ │ │ │ │ -  _B_u_g_s In line 1 of the above example a new tag named │ │ │ │ │ +  _B_u_g_s  1.  <_[_[_r_e_f_]_]_d_e_f name="imghr"> │ │ │ │ │ +  2.     │ │ │ │ │ +  3.     │ │ │ │ │ +  4.     │ │ │ │ │ +  5.     │ │ │ │ │ +  6.     │ │ │ │ │ +  7.     │ │ │ │ │ +  8.    
<_[_[_r_e_f_]_]_i_m_g │ │ │ │ │ + src="leftsep.png"> <_[_[_r_e_f_]_]_i_m_g │ │ │ │ │ + src="rightsep.png">
│ │ │ │ │ +  9.  <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ + 10. │ │ │ │ │ + 11.  paragraph │ │ │ │ │ + 12.   │ │ │ │ │ + 13.  paragraph │ │ │ │ │ + In line 1 of the above example a new tag named │ │ │ │ │ imghr is defined. The html code which implements │ │ │ │ │ this rule is following in lines 2-8. between the _[ │ │ │ │ │ _[_r_e_f_]_]_d_e_f_ _a_n_d_ _/_d_e_f tags. You don't have to │ │ │ │ │ understand this html code, but you should │ │ │ │ │ understand that this is just pure html to draw the │ │ │ │ │ fancy rule. Every time you write as in line │ │ │ │ │ 12 htp will replace this tag with the corresponding │ │ │ │ │ @@ -27,42 +44,51 @@ │ │ │ │ │ Often you want to define tags that have an opening │ │ │ │ │ and a closing variant. For this purpose you should │ │ │ │ │ use the _[_[_r_e_f_]_]_b_l_o_c_k_d_e_f tag. When htp encounters a │ │ │ │ │ blockdef tag it will automatically search for the │ │ │ │ │ matching closing tag and put everything between │ │ │ │ │ these tags in a block macro named block. Here is an │ │ │ │ │ example for this. │ │ │ │ │ -  1. <_[_[_r_e_f_]_]_U_N_D_E_F tagname> │ │ │ │ │ -  2. <_[_[_r_e_f_]_]_U_N_D_E_F tagname1 tagname2 ... > │ │ │ │ │ -  3. │ │ │ │ │ +  1. <_[_[_r_e_f_]_]_O_P_T (IMGXY|NOIMGXY)> │ │ │ │ │ +  2. <_[_[_r_e_f_]_]_O_P_T (QUIET|VERBOSE)> │ │ │ │ │ +  3. <_[_[_r_e_f_]_]_O_P_T (DEPEND|NODEPEND)> │ │ │ │ │ +  4. <_[_[_r_e_f_]_]_O_P_T (PRECIOUS|NOPRECIOUS)> │ │ │ │ │ +  5. <_[_[_r_e_f_]_]_O_P_T (CONDENSE|SEMICONDENSE|NOCONDENSE)> │ │ │ │ │ +  6. <_[_[_r_e_f_]_]_O_P_T DELIM=(HTML|SQUARE|CURLY)> │ │ │ │ │ +  7. <_[_[_r_e_f_]_]_O_P_T (XML|XML=FALSE)> │ │ │ │ │ +  8. │ │ │ │ │ ********** 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_]_]_S_E_T emailaddr="jnelson@crl.com"> │ │ │ │ │ +  1.   <_[_[_r_e_f_]_]_d_e_f name="sharedimg" option="name │ │ │ │ │ + alt"> │ │ │ │ │ +  2.     <_[_[_r_e_f_]_]_i_m_g src="/home/sharedimages/$ │ │ │ │ │ + {name}" alt="${alt}">; │ │ │ │ │ +  3.   <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ +  4. │ │ │ │ │ +  5.   │ │ │ │ │ ********** 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 │ │ │ │ │ tricky, so here we present the way to do this: │ │ │ │ │ -  1. <_[_[_r_e_f_]_]_b_l_o_c_k stuff> │ │ │ │ │ -  2.   send email │ │ │ │ │ -  3. <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ -  4. │ │ │ │ │ -  5. <_[_[_r_e_f_]_]_s_e_t morestuff=$email> │ │ │ │ │ -  6. │ │ │ │ │ -  7. This works:     <_[_[_r_e_f_]_]_u_s_e stuff │ │ │ │ │ - email="jnelson@crl.com"> │ │ │ │ │ -  8. But this fails: <_[_[_r_e_f_]_]_u_s_e email> │ │ │ │ │ -  9. And this fails: <_[_[_r_e_f_]_]_u_s_e morestuff │ │ │ │ │ - email="jnelson@crl.com"> │ │ │ │ │ +  1.   <_[_[_r_e_f_]_]_s_e_t sect-ctr="0"> │ │ │ │ │ +  2.   <_[_[_r_e_f_]_]_b_l_o_c_k_d_e_f name="section"> │ │ │ │ │ +  3.     <_[_[_r_e_f_]_]_i_n_c sect-ctr> │ │ │ │ │ +  4.     <_[_[_r_e_f_]_]_b_l_o_c_k name="sect-${sect-ctr}" │ │ │ │ │ + expand global> │ │ │ │ │ +  5.       <_[_[_r_e_f_]_]_u_s_e block noexpand> │ │ │ │ │ +  6.     <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ +  7.   <_[_[_r_e_f_]_]_/_b_l_o_c_k_d_e_f> │ │ │ │ │ This defines a block macro named section. This │ │ │ │ │ macro uses a counter sect-ctr that enumerates the │ │ │ │ │ sections. It is increased for every section (line │ │ │ │ │ 3) and then the block macro name is build from this │ │ │ │ │ counter. So the first section is stored in block │ │ │ │ │ sect-1, the second in sect-2 and so on. The _[ │ │ │ │ │ _[_r_e_f_]_]_g_l_o_b_a_l flag in line 4 tells htp that these │ │ │ │ │ @@ -85,17 +111,21 @@ │ │ │ │ │ block to be expanded twice. If you omit it, it │ │ │ │ │ would be expanded when defining the sect-1 macro │ │ │ │ │ and when using it later in the template. Generally │ │ │ │ │ it is a good idea to use noexpand whenever you use │ │ │ │ │ expand in a block around it. │ │ │ │ │ To close this example we show how to expand the │ │ │ │ │ sect-${sect-ctr} blocks in the template: │ │ │ │ │ -  1. mailto hyperlink │ │ │ │ │ -  2. another │ │ │ │ │ - hyperlink │ │ │ │ │ +  1. <_[_[_r_e_f_]_]_f_i_l_e include="header.hti"> │ │ │ │ │ +  2.   <_[_[_r_e_f_]_]_s_e_t sect-ctr="1"> │ │ │ │ │ +  3.   <_[_[_r_e_f_]_]_w_h_i_l_e sect-${sect-ctr}> │ │ │ │ │ +  4.     <_[_[_r_e_f_]_]_u_s_e sect-${sect-ctr}> │ │ │ │ │ +  5.     <_[_[_r_e_f_]_]_i_n_c sect-ctr> │ │ │ │ │ +  6.   <_[_[_r_e_f_]_]_/_w_h_i_l_e> │ │ │ │ │ +  7. <_[_[_r_e_f_]_]_f_i_l_e include="footer.hti"> │ │ │ │ │ The _[_[_r_e_f_]_]_w_h_i_l_e tag in line 3 checks whether the │ │ │ │ │ macro sect-${sect-ctr} is defined. If it is defined │ │ │ │ │ the body is evaluated, which expands the macro and │ │ │ │ │ increases sect-ctr. Afterwards the while condition │ │ │ │ │ is checked again to check for sect-2 macro. This │ │ │ │ │ repeats until sect-${sect-ctr} is not defined. │ │ │ │ │ ********** CCoonncclluussiioonnss ********** │ │ │ ├── ./usr/share/doc/htp/opt.html │ │ │ │ @@ -114,38 +114,21 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ -  <[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">
│ │ │ │ +  <[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>
│ │ │ │

│ │ │ │

synopsis

│ │ │ │ OPT is an htp tag that can be used to specify processing │ │ │ │ options inside the actual document being processed. The options are │ │ │ │ used exactly as they would be on the command-line, although they are not │ │ │ │ preceded by a ‘-’ character. │ │ │ │

│ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,56 +1,36 @@ │ │ │ │ │ [HTP] │ │ │ │ │ ************ hhttpp oonn--lliinnee rreeffeerreennccee :: OOPPTT ************ │ │ │ │ │ _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_]_]_D_E_F NAME="HEADERIMG" OPTION="SRC TITLE │ │ │ │ │ -  _L_i_c_e_n_s_e SIZE"> │ │ │ │ │ -  _T_u_t_o_r_i_a_l     <_[_[_r_e_f_]_]_I_F size> │ │ │ │ │ -  _U_s_a_g_e         │ │ │ │ │ -  HTP Tags     <_[_[_r_e_f_]_]_/_I_F> │ │ │ │ │ -    _A_L_T_T_E_X_T     <_[_[_r_e_f_]_]_I_M_G SRC=pics/${src}> │ │ │ │ │ -    _B_L_O_C_K     <_[_[_r_e_f_]_]_U_S_E title> │ │ │ │ │ -    _B_L_O_C_K_D_E_F     <_[_[_r_e_f_]_]_I_F size> │ │ │ │ │ -    _D_E_F         │ │ │ │ │ -    _F_I_L_E     <_[_[_r_e_f_]_]_/_I_F> │ │ │ │ │ -    _I_F   <_[_[_r_e_f_]_]_/_D_E_F> │ │ │ │ │ -    _I_N_C │ │ │ │ │ -    _I_M_G   │ │ │ │ │ -  [>] _O_P_T │ │ │ │ │ -    _O_U_T_P_U_T   │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n   <_[_[_r_e_f_]_]_s_e_t sect-ctr="0"> │ │ │ │ │ +  _L_i_c_e_n_s_e   <_[_[_r_e_f_]_]_b_l_o_c_k_d_e_f name="section"> │ │ │ │ │ +  _T_u_t_o_r_i_a_l     <_[_[_r_e_f_]_]_i_n_c sect-ctr> │ │ │ │ │ +  _U_s_a_g_e     <_[_[_r_e_f_]_]_b_l_o_c_k name="sect-${sect-ctr}" expand │ │ │ │ │ +  HTP Tags global> │ │ │ │ │ +    _A_L_T_T_E_X_T       <_[_[_r_e_f_]_]_u_s_e block noexpand> │ │ │ │ │ +    _B_L_O_C_K     <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ +    _B_L_O_C_K_D_E_F   <_[_[_r_e_f_]_]_/_b_l_o_c_k_d_e_f> │ │ │ │ │ +    _D_E_F ********** ssyynnooppssiiss ********** │ │ │ │ │ +    _F_I_L_E OOPPTT is an htp tag that can be used to specify │ │ │ │ │ +    _I_F processing options inside the actual document being │ │ │ │ │ +    _I_N_C processed. The options are used exactly as they │ │ │ │ │ +    _I_M_G would be on the command-line, although they are not │ │ │ │ │ +    _I_M_A_G_E_U_R_L preceded by a ‘-’ character. │ │ │ │ │ +  [>] _O_P_T Click here for _m_o_r_e_ _i_n_f_o_r_m_a_t_i_o_n_ _o_n_ _u_s_i_n_g │ │ │ │ │ +    _O_U_T_P_U_T _c_u_s_t_o_m_i_z_a_t_i_o_n_ _o_p_t_i_o_n_s_ _w_i_t_h_ _h_t_p. │ │ │ │ │ +    _Q_U_O_T_E │ │ │ │ │     _S_E_T │ │ │ │ │ -    _U_N_D_E_F   This will fail: │ │ │ │ │ -    _U_N_S_E_T   │ │ │ │ │ +    _U_N_D_E_F │ │ │ │ │ +    _U_N_S_E_T │ │ │ │ │ +    _U_S_E_,_ _$ │ │ │ │ │     _W_H_I_L_E │ │ │ │ │ -    _<_!_-_-_-   Instead, use * like this: │ │ │ │ │ -  _H_i_s_t_o_r_y   <_[_[_r_e_f_]_]_D_E_F NAME="MYIMG" OPTION="SRC *"> │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t     <_[_[_r_e_f_]_]_I_M_G SRC="pics/${src}" $*> │ │ │ │ │ -  _B_u_g_s   <_[_[_r_e_f_]_]_/_D_E_F> │ │ │ │ │ -     │ │ │ │ │ -   │ │ │ │ │ - ********** ssyynnooppssiiss ********** │ │ │ │ │ - OOPPTT is an htp tag that can be used to specify │ │ │ │ │ - processing options inside the actual document being │ │ │ │ │ - processed. The options are used exactly as they │ │ │ │ │ - would be on the command-line, although they are not │ │ │ │ │ - preceded by a ‘-’ character. │ │ │ │ │ - Click here for _m_o_r_e_ _i_n_f_o_r_m_a_t_i_o_n_ _o_n_ _u_s_i_n_g │ │ │ │ │ - _c_u_s_t_o_m_i_z_a_t_i_o_n_ _o_p_t_i_o_n_s_ _w_i_t_h_ _h_t_p. │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ +    _<_!_-_-_- │ │ │ │ │ +  _H_i_s_t_o_r_y │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t │ │ │ │ │ +  _B_u_g_s │ │ │ ├── ./usr/share/doc/htp/quote.html │ │ │ │ @@ -114,17 +114,15 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ -<[ref]unset macroname>
│ │ │ │ -<[ref]unset macroname1 macroname2 ... >
│ │ │ │ -
│ │ │ │ +    <[ref]SET emailaddr="jnelson@crl.com">
│ │ │ │

│ │ │ │

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,20 +1,20 @@ │ │ │ │ │ [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 <_[_[_r_e_f_]_]_u_n_s_e_t macroname> │ │ │ │ │ -  _L_i_c_e_n_s_e <_[_[_r_e_f_]_]_u_n_s_e_t macroname1 macroname2 ... > │ │ │ │ │ -  _T_u_t_o_r_i_a_l │ │ │ │ │ -  _U_s_a_g_e ********** ssyynnooppssiiss ********** │ │ │ │ │ -  HTP Tags QQUUOOTTEE is used to quote a macro that would otherwise │ │ │ │ │ -    _A_L_T_T_E_X_T be interpreted by HTP. It may be useful in │ │ │ │ │ -    _B_L_O_C_K conjunction with a surrounding _E_X_P_A_N_Ded block to │ │ │ │ │ -    _B_L_O_C_K_D_E_F prevent early expansion of some contained blocks. │ │ │ │ │ -    _D_E_F Note that '$' evaluation is still done inside a │ │ │ │ │ -    _F_I_L_E quote block. │ │ │ │ │ +  _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 QQUUOOTTEE is used to quote a macro that would otherwise │ │ │ │ │ +  _U_s_a_g_e be interpreted by HTP. It may be useful in │ │ │ │ │ +  HTP Tags conjunction with a surrounding _E_X_P_A_N_Ded block to │ │ │ │ │ +    _A_L_T_T_E_X_T prevent early expansion of some contained blocks. │ │ │ │ │ +    _B_L_O_C_K Note that '$' evaluation is still done inside a │ │ │ │ │ +    _B_L_O_C_K_D_E_F quote block. │ │ │ │ │ +    _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 │ │ │ │ │   [>] _Q_U_O_T_E │ │ │ │ │ @@ -25,16 +25,14 @@ │ │ │ │ │     _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,33 +114,24 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

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

│ │ │ │

synopsis

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

│ │ │ │ -<[ref]block stuff>
│ │ │ │ -  <a href=$email>send email</a>
│ │ │ │ -<[ref]/block>
│ │ │ │ +<[ref]UNDEF tagname>
│ │ │ │ +<[ref]UNDEF tagname1 tagname2 ... >
│ │ │ │
│ │ │ │ -<[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">
│ │ │ │

│ │ │ │

│ │ │ │ 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,48 +1,36 @@ │ │ │ │ │ [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   <_[_[_r_e_f_]_]_d_e_f name="sharedimg" option="name alt"> │ │ │ │ │ -  _L_i_c_e_n_s_e     <_[_[_r_e_f_]_]_i_m_g src="/home/sharedimages/${name}" │ │ │ │ │ -  _T_u_t_o_r_i_a_l alt="${alt}">; │ │ │ │ │ -  _U_s_a_g_e   <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ -  HTP Tags │ │ │ │ │ -    _A_L_T_T_E_X_T   │ │ │ │ │ -    _B_L_O_C_K ********** ssyynnooppssiiss ********** │ │ │ │ │ -    _B_L_O_C_K_D_E_F SSEETT creates a macro definition that can later be │ │ │ │ │ -    _D_E_F expanded anywhere in the HTML document. To create a │ │ │ │ │ -    _F_I_L_E macro: │ │ │ │ │ -    _I_F <_[_[_r_e_f_]_]_b_l_o_c_k stuff> │ │ │ │ │ -    _I_N_C   send email │ │ │ │ │ -    _I_M_G <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ -    _I_M_A_G_E_U_R_L │ │ │ │ │ -    _O_P_T <_[_[_r_e_f_]_]_s_e_t morestuff=$email> │ │ │ │ │ -    _O_U_T_P_U_T │ │ │ │ │ -    _Q_U_O_T_E This works:     <_[_[_r_e_f_]_]_u_s_e stuff │ │ │ │ │ -  [>] _S_E_T email="jnelson@crl.com"> │ │ │ │ │ -    _U_N_D_E_F But this fails: <_[_[_r_e_f_]_]_u_s_e email> │ │ │ │ │ -    _U_N_S_E_T And this fails: <_[_[_r_e_f_]_]_u_s_e morestuff │ │ │ │ │ -    _U_S_E_,_ _$ email="jnelson@crl.com"> │ │ │ │ │ -    _W_H_I_L_E The macro "emailaddr" can then be expanded later. │ │ │ │ │ -    _<_!_-_-_- The _U_S_E tag is used to expand the macro outside a │ │ │ │ │ -  _H_i_s_t_o_r_y tag (i.e., into the regular text). If the macro │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t needs to be expanded inside a markup tag, use the │ │ │ │ │ -  _B_u_g_s _'_$_' 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. │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n <_[_[_r_e_f_]_]_Q_U_O_T_E TAG [ATTRIBUTE=VALUE ...]> │ │ │ │ │ +  _L_i_c_e_n_s_e │ │ │ │ │ +  _T_u_t_o_r_i_a_l ********** ssyynnooppssiiss ********** │ │ │ │ │ +  _U_s_a_g_e SSEETT creates a macro definition that can later be │ │ │ │ │ +  HTP Tags expanded anywhere in the HTML document. To create a │ │ │ │ │ +    _A_L_T_T_E_X_T macro: │ │ │ │ │ +    _B_L_O_C_K <_[_[_r_e_f_]_]_U_N_D_E_F tagname> │ │ │ │ │ +    _B_L_O_C_K_D_E_F <_[_[_r_e_f_]_]_U_N_D_E_F tagname1 tagname2 ... > │ │ │ │ │ +    _D_E_F │ │ │ │ │ +    _F_I_L_E The macro "emailaddr" can then be expanded later. │ │ │ │ │ +    _I_F The _U_S_E tag is used to expand the macro outside a │ │ │ │ │ +    _I_N_C tag (i.e., into the regular text). If the macro │ │ │ │ │ +    _I_M_G needs to be expanded inside a markup tag, use the │ │ │ │ │ +    _I_M_A_G_E_U_R_L _'_$_' operator. │ │ │ │ │ +    _O_P_T Multiple macros can be declared in a single markup │ │ │ │ │ +    _O_U_T_P_U_T tag, as the second syntax line shows. │ │ │ │ │ +    _Q_U_O_T_E SET should only be used for a single line's worth │ │ │ │ │ +  [>] _S_E_T of text. Multi-line macros can be defined with the │ │ │ │ │ +    _U_N_D_E_F _B_L_O_C_K tag. The _B_L_O_C_K tag is also useful if the │ │ │ │ │ +    _U_N_S_E_T macro contains a quotation character and you don't │ │ │ │ │ +    _U_S_E_,_ _$ want to fool around with special escape characters. │ │ │ │ │ +    _W_H_I_L_E Macros can be redefined by using another SET │ │ │ │ │ +    _<_!_-_-_- command with the same macro name. The prior │ │ │ │ │ +  _H_i_s_t_o_r_y definition will be destroyed, however. Also, the │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t macro can be removed (destroyed) with the _U_N_S_E_T │ │ │ │ │ +  _B_u_g_s 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 Wed Jun 11, 2025 │ │ │ │ + last updated Wed May 08, 2024 │ │ │ │ │ │ │ │ │ │ │ │ ├── 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 Wed Jun 11, 2025 │ │ │ │ │ +last updated Wed May 08, 2024 │ │ │ ├── ./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 Wed Jun 11, 2025 │ │ │ │ +last updated Wed May 08, 2024 │ │ │ │ │ │ │ │ ├── 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 Wed Jun 11, 2025 │ │ │ │ │ +Copyright by Joe Doe, _w_e_b_m_a_s_t_e_r_@_d_o_m_a_i_n_._c_o_m, last updated Wed May 08, 2024 │ │ │ ├── ./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 Wed Jun 11, 2025 │ │ │ │ + last updated Wed May 08, 2024 │ │ │ │ │ │ │ │ │ │ │ │ ├── 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 Wed Jun 11, 2025 │ │ │ │ │ +last updated Wed May 08, 2024 │ │ │ ├── ./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 Wed Jun 11, 2025 │ │ │ │ + last updated Wed May 08, 2024 │ │ │ │ │ │ │ │ │ │ │ │ ├── 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 Wed Jun 11, 2025 │ │ │ │ │ +last updated Wed May 08, 2024 │ │ │ ├── ./usr/share/doc/htp/undef.html │ │ │ │ @@ -114,19 +114,15 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

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

│ │ │ │

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,23 +1,23 @@ │ │ │ │ │ [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   <_[_[_r_e_f_]_]_d_e_f name="sharedimg" option="name alt"> │ │ │ │ │ -  _L_i_c_e_n_s_e     <_[_[_r_e_f_]_]_i_m_g src="/home/sharedimages/${name}" │ │ │ │ │ -  _T_u_t_o_r_i_a_l alt="${alt}">; │ │ │ │ │ -  _U_s_a_g_e   <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ -  HTP Tags │ │ │ │ │ -    _A_L_T_T_E_X_T   │ │ │ │ │ -    _B_L_O_C_K ********** ssyynnooppssiiss ********** │ │ │ │ │ -    _B_L_O_C_K_D_E_F UUNNDDEEFF removes a metatag definition. Metatags │ │ │ │ │ -    _D_E_F created by _D_E_F and _B_L_O_C_K_D_E_F can be removed with the │ │ │ │ │ -    _F_I_L_E UNDEF command. Once removed, the metatag will no │ │ │ │ │ -    _I_F longer be recognized by htp until it is reassigned. │ │ │ │ │ -    _I_N_C Multiple metatags can be removed by placing each │ │ │ │ │ -    _I_M_G name as an attribute. │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n     <_[_[_r_e_f_]_]_u_n_s_e_t email_addr> │ │ │ │ │ +  _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 │ │ │ │ │     _O_U_T_P_U_T │ │ │ │ │     _Q_U_O_T_E │ │ │ │ │     _S_E_T │ │ │ │ │   [>] _U_N_D_E_F │ │ │ │ │     _U_N_S_E_T │ │ │ │ │ @@ -25,19 +25,14 @@ │ │ │ │ │     _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,44 +114,33 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

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

│ │ │ │

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]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">
│ │ │ │ +    <[ref]unset email_addr>
│ │ │ │

│ │ │ │

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

│ │ │ │ -<a href="mailto:$email">mailto hyperlink</a>
│ │ │ │ -<a href="http://$domain/~${username}/">another hyperlink</a>
│ │ │ │ +    <[ref]unset email_addr home_url login_name>
│ │ │ │

│ │ │ │

│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,51 +1,36 @@ │ │ │ │ │ [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   <_[_[_r_e_f_]_]_d_e_f name="sharedimg" option="name alt"> │ │ │ │ │ -  _L_i_c_e_n_s_e     <_[_[_r_e_f_]_]_i_m_g src="/home/sharedimages/${name}" │ │ │ │ │ -  _T_u_t_o_r_i_a_l alt="${alt}">; │ │ │ │ │ -  _U_s_a_g_e   <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ -  HTP Tags │ │ │ │ │ -    _A_L_T_T_E_X_T   │ │ │ │ │ -    _B_L_O_C_K ********** ssyynnooppssiiss ********** │ │ │ │ │ -    _B_L_O_C_K_D_E_F UUNNSSEETT removes (or deletes) a macro and it's │ │ │ │ │ -    _D_E_F definition. The macro is subsequently not available │ │ │ │ │ -    _F_I_L_E for use in the pre-processed files. (Note that │ │ │ │ │ -    _I_F simply redefining the macro with another _S_E_T or │ │ │ │ │ -    _I_N_C _B_L_O_C_K definition with the same name is acceptable. │ │ │ │ │ -    _I_M_G The old macro definition will be removed │ │ │ │ │ -    _I_M_A_G_E_U_R_L automatically.) │ │ │ │ │ -    _O_P_T For example: │ │ │ │ │ -    _O_U_T_P_U_T <_[_[_r_e_f_]_]_b_l_o_c_k stuff> │ │ │ │ │ -    _Q_U_O_T_E   send email │ │ │ │ │ -    _S_E_T <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n <_[_[_r_e_f_]_]_u_n_s_e_t macroname> │ │ │ │ │ +  _L_i_c_e_n_s_e <_[_[_r_e_f_]_]_u_n_s_e_t macroname1 macroname2 ... > │ │ │ │ │ +  _T_u_t_o_r_i_a_l │ │ │ │ │ +  _U_s_a_g_e ********** ssyynnooppssiiss ********** │ │ │ │ │ +  HTP Tags UUNNSSEETT removes (or deletes) a macro and it's │ │ │ │ │ +    _A_L_T_T_E_X_T definition. The macro is subsequently not available │ │ │ │ │ +    _B_L_O_C_K for use in the pre-processed files. (Note that │ │ │ │ │ +    _B_L_O_C_K_D_E_F simply redefining the macro with another _S_E_T or │ │ │ │ │ +    _D_E_F _B_L_O_C_K definition with the same name is acceptable. │ │ │ │ │ +    _F_I_L_E The old macro definition will be removed │ │ │ │ │ +    _I_F automatically.) │ │ │ │ │ +    _I_N_C For example: │ │ │ │ │ +    _I_M_G     <_[_[_r_e_f_]_]_u_n_s_e_t email_addr> │ │ │ │ │ +    _I_M_A_G_E_U_R_L More than one macro may be removed in the same tag: │ │ │ │ │ +    _O_P_T     <_[_[_r_e_f_]_]_u_n_s_e_t email_addr home_url login_name> │ │ │ │ │ +    _O_U_T_P_U_T │ │ │ │ │ +    _Q_U_O_T_E │ │ │ │ │ +    _S_E_T │ │ │ │ │     _U_N_D_E_F │ │ │ │ │ -  [>] _U_N_S_E_T <_[_[_r_e_f_]_]_s_e_t morestuff=$email> │ │ │ │ │ +  [>] _U_N_S_E_T │ │ │ │ │     _U_S_E_,_ _$ │ │ │ │ │ -    _W_H_I_L_E This works:     <_[_[_r_e_f_]_]_u_s_e stuff │ │ │ │ │ -    _<_!_-_-_- email="jnelson@crl.com"> │ │ │ │ │ -  _H_i_s_t_o_r_y But this fails: <_[_[_r_e_f_]_]_u_s_e email> │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t And this fails: <_[_[_r_e_f_]_]_u_s_e morestuff │ │ │ │ │ -  _B_u_g_s email="jnelson@crl.com"> │ │ │ │ │ - More than one macro may be removed in the same tag: │ │ │ │ │ - mailto hyperlink │ │ │ │ │ - another │ │ │ │ │ - hyperlink │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ - │ │ │ │ │ +    _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/use.html │ │ │ │ @@ -114,18 +114,18 @@ │ │ │ │ Bugs │ │ │ │
│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ -  <[ref]WHILE NOT i="10">
│ │ │ │ -    ...
│ │ │ │ -    <[ref]INC i>
│ │ │ │ -  <[ref]/WHILE>
│ │ │ │ +<[ref]use macroname [parameters ...] [noexpand]>
│ │ │ │ +<... $macroname ...>
│ │ │ │ +<... ${macroname} ...>
│ │ │ │ +
│ │ │ │

│ │ │ │

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 │ │ │ │ @@ -135,23 +135,23 @@ │ │ │ │ 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]WHILE sect-$i>
│ │ │ │ - 2.     ...
│ │ │ │ - 3.     <[ref]INC i>
│ │ │ │ - 4.   <[ref]/WHILE>
│ │ │ │ - 5.   <[ref]while sect-${sect-ctr}>
│ │ │ │ - 6.     <[ref]use sect-${sect-ctr}>
│ │ │ │ - 7.     <[ref]inc sect-ctr>
│ │ │ │ - 8.   <[ref]/while>
│ │ │ │ - 9. <[ref]file include="footer.hti">
│ │ │ │ + 1. <[ref]block stuff>
│ │ │ │ + 2.   <a href=$email>send email</a>
│ │ │ │ + 3. <[ref]/block>
│ │ │ │ + 4.
│ │ │ │ + 5. <[ref]set morestuff=$email>
│ │ │ │ + 6.
│ │ │ │ + 7. This works:     <[ref]use stuff email="jnelson@crl.com">
│ │ │ │ + 8. But this fails: <[ref]use email>
│ │ │ │ + 9. And this fails: <[ref]use morestuff email="jnelson@crl.com">
│ │ │ │

│ │ │ │

│ │ │ │ (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. │ │ │ │ @@ -162,16 +162,18 @@ │ │ │ │ Inside a markup tag, like IMG, 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. <a href="mailto:$email">mailto hyperlink</a>
│ │ │ │ - 2. <a href="http://$domain/~${username}/">another hyperlink</a>
│ │ │ │ + 1.   <[ref]WHILE sect-$i>
│ │ │ │ + 2.     ...
│ │ │ │ + 3.     <[ref]INC i>
│ │ │ │ + 4.   <[ref]/WHILE>
│ │ │ │

│ │ │ │

│ │ │ │ The use of curly braces is encouraged, since it is more robust and │ │ │ │ should never cause confusion with surrounding text. If no curly │ │ │ │ braces are used the macro name consists either of a single punctuation │ │ │ │ character or the maximum sequence of letters, digits, "-" │ │ │ │ and "_" that follows it. │ │ │ │ ├── html2text {} │ │ │ │ │ @@ -1,37 +1,39 @@ │ │ │ │ │ [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   <_[_[_r_e_f_]_]_W_H_I_L_E NOT i="10"> │ │ │ │ │ -  _L_i_c_e_n_s_e     ... │ │ │ │ │ -  _T_u_t_o_r_i_a_l     <_[_[_r_e_f_]_]_I_N_C i> │ │ │ │ │ -  _U_s_a_g_e   <_[_[_r_e_f_]_]_/_W_H_I_L_E> │ │ │ │ │ +  _I_n_t_r_o_d_u_c_t_i_o_n <_[_[_r_e_f_]_]_u_s_e macroname [parameters ...] [noexpand]> │ │ │ │ │ +  _L_i_c_e_n_s_e <... $macroname ...> │ │ │ │ │ +  _T_u_t_o_r_i_a_l <... ${macroname} ...> │ │ │ │ │ +  _U_s_a_g_e │ │ │ │ │   HTP Tags ********** ssyynnooppssiiss ********** │ │ │ │ │     _A_L_T_T_E_X_T UUSSEE will expand macros that have been previously │ │ │ │ │     _B_L_O_C_K declared with either _S_E_T or _B_L_O_C_K. USE can only be │ │ │ │ │     _B_L_O_C_K_D_E_F used outside of other markup tags. │ │ │ │ │     _D_E_F If you USE a block macro the value of expanded │ │ │ │ │     _F_I_L_E block macros will be further parsed by htp. This is │ │ │ │ │     _I_F maybe not what you want, for example, if the use is │ │ │ │ │     _I_N_C inside a block which _e_x_p_a_n_d_s itself. You can use │ │ │ │ │     _I_M_G the noexpand attribute to prevent further │ │ │ │ │     _I_M_A_G_E_U_R_L expansion. │ │ │ │ │     _O_P_T USE will accept additional parameters, which are │ │ │ │ │     _O_U_T_P_U_T "local" macros for the expanded macro. This is only │ │ │ │ │     _Q_U_O_T_E valid for _B_L_O_C_K macros. Macros created using _S_E_T │ │ │ │ │     _S_E_T cannot have parameters passed. For example: │ │ │ │ │ -    _U_N_D_E_F  1.   <_[_[_r_e_f_]_]_W_H_I_L_E sect-$i> │ │ │ │ │ -    _U_N_S_E_T  2.     ... │ │ │ │ │ -  [>] _U_S_E_,_ _$  3.     <_[_[_r_e_f_]_]_I_N_C i> │ │ │ │ │ -    _W_H_I_L_E  4.   <_[_[_r_e_f_]_]_/_W_H_I_L_E> │ │ │ │ │ -    _<_!_-_-_-  5.   <_[_[_r_e_f_]_]_w_h_i_l_e sect-${sect-ctr}> │ │ │ │ │ -  _H_i_s_t_o_r_y  6.     <_[_[_r_e_f_]_]_u_s_e sect-${sect-ctr}> │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t  7.     <_[_[_r_e_f_]_]_i_n_c sect-ctr> │ │ │ │ │ -  _B_u_g_s  8.   <_[_[_r_e_f_]_]_/_w_h_i_l_e> │ │ │ │ │ -  9. <_[_[_r_e_f_]_]_f_i_l_e include="footer.hti"> │ │ │ │ │ +    _U_N_D_E_F  1. <_[_[_r_e_f_]_]_b_l_o_c_k stuff> │ │ │ │ │ +    _U_N_S_E_T  2.   send email │ │ │ │ │ +  [>] _U_S_E_,_ _$  3. <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ +    _W_H_I_L_E  4. │ │ │ │ │ +    _<_!_-_-_-  5. <_[_[_r_e_f_]_]_s_e_t morestuff=$email> │ │ │ │ │ +  _H_i_s_t_o_r_y  6. │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t  7. This works:     <_[_[_r_e_f_]_]_u_s_e stuff │ │ │ │ │ +  _B_u_g_s email="jnelson@crl.com"> │ │ │ │ │ +  8. But this fails: <_[_[_r_e_f_]_]_u_s_e email> │ │ │ │ │ +  9. And this fails: <_[_[_r_e_f_]_]_u_s_e morestuff │ │ │ │ │ + email="jnelson@crl.com"> │ │ │ │ │ (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. │ │ │ │ │ @@ -41,17 +43,18 @@ │ │ │ │ │ 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. mailto hyperlink │ │ │ │ │ -  2. another │ │ │ │ │ - hyperlink │ │ │ │ │ +  1.   <_[_[_r_e_f_]_]_W_H_I_L_E sect-$i> │ │ │ │ │ +  2.     ... │ │ │ │ │ +  3.     <_[_[_r_e_f_]_]_I_N_C i> │ │ │ │ │ +  4.   <_[_[_r_e_f_]_]_/_W_H_I_L_E> │ │ │ │ │ The use of curly braces is encouraged, since it is │ │ │ │ │ more robust and should never cause confusion with │ │ │ │ │ surrounding text. If no curly braces are used the │ │ │ │ │ macro name consists either of a single punctuation │ │ │ │ │ character or the maximum sequence of letters, │ │ │ │ │ digits, "-" and "_" that follows it. │ │ │ │ │ If a '$' character needs to be kept in the final │ │ │ ├── ./usr/share/doc/htp/while.html │ │ │ │ @@ -114,45 +114,44 @@ │ │ │ │ Bugs │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │

syntax

│ │ │ │

│ │ │ │ -  <[ref]def name="sharedimg" option="name alt">
│ │ │ │ -    <[ref]img src="/home/sharedimages/${name}" alt="${alt}">;
│ │ │ │ -  <[ref]/def>
│ │ │ │ +<[ref]block stuff>
│ │ │ │ +  <a href=$email>send email</a>
│ │ │ │ +<[ref]/block>
│ │ │ │
│ │ │ │ -  <sharedimg name="bubble.gif" alt="Bubble image">
│ │ │ │ +<[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

│ │ │ │ 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: │ │ │ │

│ │ │ │ -<[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">
│ │ │ │ +<a href="mailto:$email">mailto hyperlink</a>
│ │ │ │ +<a href="http://$domain/~${username}/">another hyperlink</a>
│ │ │ │

│ │ │ │

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

│ │ │ │ -<a href="mailto:$email">mailto hyperlink</a>
│ │ │ │ -<a href="http://$domain/~${username}/">another hyperlink</a>
│ │ │ │ +  <[ref]WHILE sect-$i>
│ │ │ │ +    ...
│ │ │ │ +    <[ref]INC i>
│ │ │ │ +  <[ref]/WHILE>
│ │ │ │

│ │ │ │

│ │ │ │ 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,40 +1,38 @@ │ │ │ │ │ [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   <_[_[_r_e_f_]_]_d_e_f name="sharedimg" option="name alt"> │ │ │ │ │ -  _L_i_c_e_n_s_e     <_[_[_r_e_f_]_]_i_m_g src="/home/sharedimages/${name}" │ │ │ │ │ -  _T_u_t_o_r_i_a_l alt="${alt}">; │ │ │ │ │ -  _U_s_a_g_e   <_[_[_r_e_f_]_]_/_d_e_f> │ │ │ │ │ -  HTP Tags │ │ │ │ │ -    _A_L_T_T_E_X_T   │ │ │ │ │ -    _B_L_O_C_K ********** ssyynnooppssiiss ********** │ │ │ │ │ -    _B_L_O_C_K_D_E_F WWHHIILLEE is the building block for repeated │ │ │ │ │ -    _D_E_F processing. The basic form is shown above. │ │ │ │ │ -    _F_I_L_E "Conditional" is either a "compare" or "is defined" │ │ │ │ │ -    _I_F operation. A compare operator is a test of the │ │ │ │ │ -    _I_N_C value of a macro against a literal string. If the │ │ │ │ │ -    _I_M_G NOT tag is present in the WHILE markup, the │ │ │ │ │ -    _I_M_A_G_E_U_R_L evaluation of the conditional is reversed: │ │ │ │ │ -    _O_P_T <_[_[_r_e_f_]_]_b_l_o_c_k stuff> │ │ │ │ │ -    _O_U_T_P_U_T   send email │ │ │ │ │ -    _Q_U_O_T_E <_[_[_r_e_f_]_]_/_b_l_o_c_k> │ │ │ │ │ -    _S_E_T │ │ │ │ │ -    _U_N_D_E_F <_[_[_r_e_f_]_]_s_e_t morestuff=$email> │ │ │ │ │ -    _U_N_S_E_T │ │ │ │ │ -    _U_S_E_,_ _$ This works:     <_[_[_r_e_f_]_]_u_s_e stuff │ │ │ │ │ -  [>] _W_H_I_L_E email="jnelson@crl.com"> │ │ │ │ │ -    _<_!_-_-_- But this fails: <_[_[_r_e_f_]_]_u_s_e email> │ │ │ │ │ -  _H_i_s_t_o_r_y And this fails: <_[_[_r_e_f_]_]_u_s_e morestuff │ │ │ │ │ -  _W_i_s_h_ _l_i_s_t email="jnelson@crl.com"> │ │ │ │ │ -  _B_u_g_s Just as with _[_[_r_e_f_]_]_I_F you can also check for a │ │ │ │ │ - macro's existance: │ │ │ │ │ - mailto hyperlink │ │ │ │ │ - another │ │ │ │ │ - hyperlink │ │ │ │ │ +  _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 WWHHIILLEE is the building block for repeated │ │ │ │ │ +    _I_M_A_G_E_U_R_L processing. The basic form is shown above. │ │ │ │ │ +    _O_P_T "Conditional" is either a "compare" or "is defined" │ │ │ │ │ +    _O_U_T_P_U_T operation. A compare operator is a test of the │ │ │ │ │ +    _Q_U_O_T_E value of a macro against a literal string. If the │ │ │ │ │ +    _S_E_T NOT tag is present in the WHILE markup, the │ │ │ │ │ +    _U_N_D_E_F evaluation of the conditional is reversed: │ │ │ │ │ +    _U_N_S_E_T mailto hyperlink │ │ │ │ │ +    _U_S_E_,_ _$ another │ │ │ │ │ +  [>] _W_H_I_L_E hyperlink │ │ │ │ │ +    _<_!_-_-_- Just as with _[_[_r_e_f_]_]_I_F you can also check for a │ │ │ │ │ +  _H_i_s_t_o_r_y macro's existance: │ │ │ │ │ +  _W_i_s_h_ _l_i_s_t   <_[_[_r_e_f_]_]_W_H_I_L_E sect-$i> │ │ │ │ │ +  _B_u_g_s     ... │ │ │ │ │ +     <_[_[_r_e_f_]_]_I_N_C i> │ │ │ │ │ +   <_[_[_r_e_f_]_]_/_W_H_I_L_E> │ │ │ │ │ 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 mmuusstt be closed with the /WHILE tag.