+ -
+ XML processing instruction
+
+ -
+
+ Attributes:
+
+
+ -
+ version
+
+ -
+ Always set to
1.0.
+
+ -
+ encoding
+
+ -
+ Character encoding used for file. Always set to
UTF-8.
+
+
+
+
+ -
+ vault
+
+ -
+
+ Parent node that contains all the vault data.
+
+
+ Attributes:
+
+
+ -
+ watermark
+
+ -
+ Identifies the file as the correct type. It is always set to
882BAD68-8C3E-44E3-BBF4-17E55143DAF8, regardless of the file version.
+
+ -
+ version-major
+
+ -
+ Identifies the major version of the file format. Must be
1.
+
+ -
+ version-minor
+
+ -
+ Identifies the minor version of the file format. Must be
0.
+
+
+
+
+ -
+ vault/categories
+
+ -
+
+ Contains a list of all categories used by the vault.
+
+
+
+ -
+ vault/categories/category
+
+ -
+
+ Contains information about a single category. There is one node per category.
+
+
+ Attributes:
+
+
+ -
+ id
+
+ -
+ Unique id of the category.
+
+
+ -
+
+
-
+ vault/categories/category/description
+
+ -
+
+ Description of the category.
+
+
+
+ -
+ vault/categories/category/snippet-keys
+
+ -
+
+ Contains list of the unique keys of all snippets in this category. May be omitted if there are no snippets in the category.
+
+
+
+ -
+ vault/categories/category/snippet-keys/key
+
+ -
+
+ Contains the key of a snippet in the category. There is one node for each snippet in the category.
+
+
+ The value must be:
+
+
+ - unique withing the vault
+ - a valid Unicode Pascal identifier
+
+
+
+ -
+ vault/snippets
+
+ -
+
+ Contains defintiions of all snippets in the vault.
+
+
+
+ -
+ vault/snippets/snippet
+
+ -
+
+ Contains information about a snippet. There is one node per snippet.
+
+
+ Attributes:
+
+
+ -
+ key
+
+ -
+
+ The snippet key.
+
+
+ The value must be:
+
+
+ - unique withing the vault
+ - a valid Unicode Pascal identifier
+
+
+ -
+ category
+
+ -
+
+ The unique id of the category to which the snippet belongs.
+
+
+ The value must correspond to the id attribute of one of the vault/categories/category nodes.
+
+
+ -
+ kind
+
+ -
+
+ The type of snippet.
+
+
+ Valid values are:
+
+
+ freeformroutinetypeconstclassunit
+
+ The values are not case sensitive.
+
+
+ If vault/snippets/snippet/source-code/language has any value other than Pascal then this attribute must have value freeform.
+
+
+
+
+
+ -
+ vault/snippets/snippet/display-name
+
+ -
+
+ The snippet's display name.
+
+
+
+ -
+ vault/snippets/snippet/description
+
+ -
+
+ Description of the snippet.
+
+
+ Content must be valid REML markup. REML v6 is supported.
+
+
+ This node may be omitted if there is no description.
+
+
+
+ -
+ vault/snippets/snippet/notes
+
+ -
+
+ Additional information about the snippet.
+
+
+ Content must be valid REML markup. REML v6 is supported.
+
+
+ This node may be omitted if there are no notes.
+
+
+
+ -
+ vault/snippets/snippet/source-code
+
+ -
+
+ Contains information about a snippet's source code.
+
+
+ Attributes:
+
+
+ -
+ file-name
+
+ -
+
+ Name of the file containing the snippet's source code.
+
+
+ The named file must exist in the same directory as this XML file.
+
+
+ -
+ language
+
+ -
+
+ Identifies the programming language, if any, used by the source code.
+
+
+ Valid values are:
+
+
+ -
+
text – the snippet is plain text, not source code.
+
+ -
+
unknown – the snippet's source code language is unknown to CodeSnip.
+
+ -
+
pascal – the snippet's source code is written in Object Pascal.
+
+
+
+
+
+
+ -
+ vault/snippets/snippet/compile-results
+
+ -
+
+ Contains a list of compile results for the snippet.
+
+
+ This node has no meaning and must be omitted if either of the following two conditions apply:
+
+
+ -
+ The source code language is not
pascal.
+
+ -
+ The snippet kind is
freeform.
+
+
+
+
+ -
+ vault/snippets/snippet/compile-results/compiler
+
+
+ -
+
+ The compile result for a given compiler. There is an entry for each known compiler.
+
+
+ Attributes:
+
+
+ -
+ id
+
+ -
+
+ Identifies the compiler. Valid identifiers are are one of:
+
+
+ -
+ d2 – Delphi 2 compiler
+
+ -
+ d3 – Delphi 3 compiler
+
+ -
+ d4 – Delphi 4 compiler
+
+ -
+ d5 – Delphi 5 compiler
+
+ -
+ d6 – Delphi 6 compiler
+
+ -
+ d7 – Delphi 7 compiler
+
+ -
+ d2005 – Delphi 2005 compiler
+
+ -
+ d2006 – Delphi 2006 compiler
+
+ -
+ d2007 – Delphi 2007 compiler
+
+ -
+ d2009 – Delphi 2009 compiler
+
+ -
+ d2010 – Delphi 2010 compiler
+
+ -
+ dXE – Delphi XE compiler
+
+ -
+ dxe2 – Delphi XE2 compiler
+
+ -
+ dxe3 – Delphi XE3 compiler
+
+ -
+ dxe4 – Delphi XE4 compiler
+
+ -
+ dxe5 – Delphi XE5 compiler
+
+ -
+ dxe6 – Delphi XE6 compiler
+
+ -
+ dxe7 – Delphi XE7 compiler
+
+ -
+ dxe8 – Delphi XE8 compiler
+
+ -
+ d10.0 – Delphi 10 Seattle compiler
+
+ -
+ d10.1 – Delphi 10.1 Berlin compiler
+
+ -
+ d10.2 – Delphi 10.2 Tokyo compiler
+
+ -
+ d10.3 – Delphi 10.3 Rio compiler
+
+ -
+ d10.4 – Delphi 10.4 Sydney compiler
+
+ -
+ d11 – Delphi 11.x Alexandria compiler
+
+ -
+ d12 – Delphi 12 Athens compiler
+
+ -
+ fpc – Free Pascal compiler
+
+
+
+ The values are not case sensitive.
+
+
+ -
+ result
+
+ -
+
+ The compile result for the compiler. Valid values are:
+
+
+ -
+
y – Compiles with the identified compiler.
+
+ -
+
n – Does not compile with the identified compiler.
+
+ -
+
q – Compile result for this compiler is not known.
+
+
+
+ The values are not case sensitive.
+
+
+
+
+ There is no text content.
+
+
+ Omitting a node for any compiler is permitted and is equivalent to specifying q.
+
+
+
+ -
+ vault/snippets/snippet/tests
+
+ -
+
+ Provides information about the level of testing applied to this snippet.
+
+
+ Attributes:
+
+
+ -
+ level
+
+ -
+
+ The level of testing achieved. Valid values are:
+
+
+ -
+
none – the snippet has not been tested.
+
+ -
+
basic – the snippet has passed some simple, unspecified testing.
+
+ -
+
advanced – the snippet has passed more advanced, but unspecified testing.
+
+ -
+
unit-tests – the snippet has passed unit tests.
+
+ -
+
demo-code – there exists demo code that exercises the snippet.
+
+
+
+ -
+ url
+
+ -
+
+ The URL of any unit tests or demo code.
+
+
+ This attribute must only be provided when the level attribute has value unit-tests or demo-code.
+
+
+
+
+ There is no text content.
+
+
+ This node may be omitted if the unit has not been tested. In this case a testing level of none will be assumed.
+
+
+
+ -
+ vault/snippets/snippet/required-units
+
+ -
+
+ List of units required to compile the snippet.
+
+
+ The node may be omitted if there are no required units.
+
+
+ If vault/snippets/snippet/source-code/language has any value other than Pascal then this node has no meaning and must be omitted.
+
+
+
+
+ -
+ vault/snippets/snippet/required-units/unit
+
+ -
+
+ Name of a unit within the required units list.
+
+
+ Must be a valid Pascal identifier.
+
+
+
+ -
+ vault/snippets/snippet/required-snippets
+
+ -
+
+ List of snippets that are required to compile the snippet.
+
+
+ The node may be omitted if there are no required snippets.
+
+
+ If vault/snippets/snippet/source-code/language has any value other than Pascal then this node has no meaning and must be omitted.
+
+
+
+ -
+ vault/snippets/snippet/required-snippets/key
+
+ -
+
+ Key of a snippet within the required snippets list.
+
+
+
+ -
+ vault/snippets/snippet/xrefs
+
+ -
+
+ List of cross-referenced snippets.
+
+
+ The node may be omitted if there are no cross referenced snippets.
+
+
+
+ -
+ vault/snippets/snippet/xrefs/key
+
+ -
+
+ Key of a snippet within the cross-references list.
+
+
+
+ -
+ vault/license
+
+ -
+
+ Contains license information for the vault.
+
+
+ Attributes:
+
+
+ -
+ spdx
+
+ -
+
+ The license's SPDX identifier.
+
+
+ If the license has a SPDX identifier the attribute's value must be a valid SPDX identifier from the SPDX License List.
+
+
+ If the license has no associated SPDX identifier then this attribute may be either omitted or have an empty value.
+
+
+ -
+ name
+
+ -
+
+ The name of the license.
+
+
+ If the spdx attribute refers to a valid SPDX identifier then this attribute should, but is not required to, contain the name of the matching license per the SPDX License List.
+
+ If no license name is provided then this attribute may be either omitted or have an empty value.
+
+
+ -
+ url
+
+ -
+
+ The URL of the full license text.
+
+
+ If a URL is provided then the linked license should, but is not required to, have the same text as any license text in the file referenced by the license-file-name attribute.
+
+
+ If no license URL is provided then this attribute may be either omitted or have an empty value.
+
+
+ -
+ license-file-name
+
+ -
+
+ The name of a file containing the full license text.
+
+
+ If a file name is provided then it must refer to an existing, non-empty, file in the same folder as the XML file.
+
+
+ If no such license files exists then this attribute may be either omitted or have an empty value.
+
+
+
+
+ This node has no text content.
+
+
+ The node may be omitted if there are no values for any attributes. A missing node is taken to mean that there is no license information.
+
+
+
+ -
+ vault/copyright
+
+ -
+
+ Contains information about the copyright that applies to the vault.
+
+
+ Attributes:
+
+
+ -
+ date
+
+ -
+
+ The date of the copyright.
+
+
+ The copyright date may be either a year (e.g. 2024) or a range of years (e.g. 2009-2021).
+
+
+ If no copyright date is provided then this attribute may be either omitted or have an empty value.
+
+
+ -
+ holder
+
+ -
+
+ The name(s) of the copyright holder(s).
+
+
+ If there are numerous contributors to the vault, who each have a claim on copyright, they must be listed under the vault/copyright/contributors node and this attribute's value should refer to the fact, e.g. Alice Jones & contributors or simply Contributors.
+
+
+ If no copyright holder is provided then this attribute may be either omitted or have an empty value.
+
+
+ -
+ holder-url
+
+ -
+
+ A URL where additional copyright information can be found.
+
+
+ If there is no such URL then this attribute may be either omitted or have an empty value.
+
+
+
+ The node may be omitted if there are no values for any attributes the vault/copyright/contributors is not present. A missing node is taken to mean that there is no copyright information.
+
+
+
+
+ -
+ vault/copyright/contributors
+
+ -
+
+ Contains a list of contributors to the project who have a claim on copyright.
+
+
+ The node may be omitted if there are no contributors.
+
+
+
+ -
+ vault/copyright/contributors/name
+
+ -
+
+ The name of a contributor. One node per contributor.
+
+
+
+ -
+ vault/acknowledgements
+
+ -
+
+ Contains a list of names of people who have contributed in some way the the project.
+
+
+ The node may be omitted if no people are acknowledged.
+
+
+
+ -
+ vault/acknowledgements/name
+
+ -
+
+ Name being acknowledged. One node per name in the list.
+
+
+
+
+
+
+ Source code is stored separately from the main XML file. The source code of each snippet has its own file. File names relate to the relevant snippet's key and have extension .source.
+
+
+