diff options
| author | Jason Albert <albertj@us.ibm.com> | 2016-08-30 15:28:09 -0500 |
|---|---|---|
| committer | Jason Albert <albertj@us.ibm.com> | 2016-08-30 15:28:09 -0500 |
| commit | d7cc969a3f6525a9417125c3caab7aa678240836 (patch) | |
| tree | 940aa190d274045a3b28c3af8f0b710c360c37f4 /docs/xmlformat.md | |
| parent | 7c5db5a6ff8fc6f2454b0e848cd19e38ea84528a (diff) | |
| download | vpdtools-d7cc969a3f6525a9417125c3caab7aa678240836.tar.gz vpdtools-d7cc969a3f6525a9417125c3caab7aa678240836.zip | |
Added <record> section to doc
Diffstat (limited to 'docs/xmlformat.md')
| -rw-r--r-- | docs/xmlformat.md | 58 |
1 files changed, 57 insertions, 1 deletions
diff --git a/docs/xmlformat.md b/docs/xmlformat.md index 264d613..ba01d76 100644 --- a/docs/xmlformat.md +++ b/docs/xmlformat.md @@ -74,4 +74,60 @@ A sample `<vpd>` section would look like this: <VD>01</VD> <record ..> </vpd> -```
\ No newline at end of file +``` + +## `<record>` +The record tag is used to describe the information that will go into a VPD record. You can specify this information 3 different ways. + * By defining the keywords to go in the record using the `<keyword>` tag + * By pointing to a different file with the `<rtvpdfile>` tag. That file contains the record definition that uses the `<keyword>` tag + * By pointing to a fully created binary representation of the record using the `<rbinfile>` tag +One 1 of these 3 tags can be given at a time and the creation program checks to make sure that is the case. + +``` xml +<record name=”NAME”> +</record> +``` +The name attribute is required in a ```<record>``` and must be 4 characters long. + +### Tags included in the `<record>` +`<rdesc></rdesc>` +A text description of the contents/purpose of a record. Only 1 `<rdesc>` is allowed per record + +``` xml +<keyword> + .. +</keyword> +``` +Defines a keyword within a record. Please see the `<keyword>` section of the document for further descriptions. + +`<rtvpdfile></rtvpdfile>` +Contains the name or path and name to a file describing the record + +`<rbinfile></rbinfile>` +Contains the name or path and name to the binary version of a record. It is assumed that this file is correctly formatted and only minimally checked to make sure the record names match. + +A sample `<record>` section would look like this: + +``` xml +<record name=”NAME”> + <rdesc> The NAME record</rdesc> + <keyword..> +</record> +``` + +The inclusion of a record tvpd file would look like this: +``` xml +<record name=”NAME”> + <rtvdfile>record-NAME.tvpd</rtvpdfile> +</record> +``` + +The inclusion of a record binary file would look like this: +``` xml +<record name=”NAME”> + <rbinfile>record-NAME.bin</rbinfile> +</record> +``` + +## Examples +Please see the examples dir in this repo for complete representations multiple types of template files
\ No newline at end of file |

