From 2f206e021e33e47c7acb35cd550e4ab9cfbc70d8 Mon Sep 17 00:00:00 2001 From: Roland Gruber Date: Sun, 10 Jul 2005 11:16:07 +0000 Subject: [PATCH] Documented PDF syntax --- lam/docs/devel/modules-specification.htm | 104 +++++++++++++++++++++++ 1 file changed, 104 insertions(+) diff --git a/lam/docs/devel/modules-specification.htm b/lam/docs/devel/modules-specification.htm index f725b6d2..81ef52fe 100644 --- a/lam/docs/devel/modules-specification.htm +++ b/lam/docs/devel/modules-specification.htm @@ -1039,6 +1039,110 @@ which should be displayed when this help entry is called.


5. PDF syntax

+The get_pdfEntries() function uses XML formatted commands to define the +PDF output. Each part in the PDF document is surrounded by "<block>" +and "</block>".
+
+Inside the <block> tags there are different ways to format the +output:
+ +
+Special commands:
+ +
+Examples:
+
+1. Simple name+value lines:
+
+In most cases you will just want to display a single line per attribute +with its name and value.
+
+    'myAttribute' +=> '<block><key>AttrName</key><value>12345</value></block>'
+
+This will give the following PDF output: AttrName: 12345
+
+
+2. Multiline values:

+
+Sometimes you have multivalued attributes where it is not applicable to +write all values in one line but where you want to list your values one +below the other or show a table.
+This can be done by using the <td> tag. This example only uses +one column but can just use more <td> tags per <block> tag +to display more columns.
+
+    'myAttribute' +=> '<block><key>AttrName</key><td +align=\"L\">123</td></block><block><td +align=\"L\">456</td></block><block><td +align=\"L\">789</td></block>'
+
+This will give the following PDF output:
+
+ + + + + + + + + + + + + + + +
AttrName:
+
123
+

+
456
+

+
789
+
+
+


6. Module meta data