summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJason Albert <albertj@us.ibm.com>2016-10-19 14:39:58 -0500
committerJason Albert <albertj@us.ibm.com>2016-10-19 14:39:58 -0500
commit55d22d71deb9f8774a6bc5afbdac5f30b872e382 (patch)
tree485cedab8575faa4765b8748cc26d1f83386dbfd
parentd24f9fdb7101d95dd4f0a3fe23565e2e626b2f6e (diff)
downloadvpdtools-55d22d71deb9f8774a6bc5afbdac5f30b872e382.tar.gz
vpdtools-55d22d71deb9f8774a6bc5afbdac5f30b872e382.zip
Updated formatting doc with new ktvpdfile info
-rw-r--r--docs/xmlformat.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/xmlformat.md b/docs/xmlformat.md
index 249081e..f8a7ae5 100644
--- a/docs/xmlformat.md
+++ b/docs/xmlformat.md
@@ -141,6 +141,10 @@ The name attribute is required and only 2 characters long
### Tags included in the `<keyword>`
+`<ktvpdfile></ktvpdfile>`
+Contains the name or path and name to a file describing the keyword
+This tag is mutually exclusive from the '<kwdesc>', '<kwformat>', '<kwlen>' and '<kwdata>' below
+
`<kwdesc></kwdesc>`
A description of the contents of the keyword. Only 1 tag allowed per keyword.
@@ -189,5 +193,12 @@ For bin data:
</keyword>
```
+The inclusion of a keyword kvpd file would look like this:
+``` xml
+<keyword name=”NM”>
+ <ktvdfile>vini-nm.xml</ktvpdfile>
+</keyword>
+```
+
## Examples
Please see the examples dir in this repo for complete representations multiple types of template files \ No newline at end of file
OpenPOWER on IntegriCloud