Skip to content
Kyle Stiemann edited this page Aug 25, 2015 · 5 revisions

Vdldoc

Please visit http://vdldoc.omnifaces.org/, the Vdldoc home page for more general information about Vdldoc.

vdldoc Elements

Vdldoc extends the default JSF documentation features in order to include information such as component deprecation and version information in your documentation. To use these extension elements, you must specify the vdldoc namespace in your taglib.xml file or your composite component .xhtml file. To utilize the new vdldoc namespace, simply add xmlns:vdldoc="http://vdldoc.omnifaces.org" to the facelet-taglib element in your taglib.xml file, or if you are using the namespace in a composite component, add it to the ui:component element in your .xhtml file.


Note: Vdldoc 1.2 uses the namespace http://vdldoc.org/vdldoc. Version 2.0+ uses the namespace http://vdldoc.omnifaces.org.

Vdldoc Elements:

Vdldoc XML Schema

If you want to specify the .xml schema to your file for validation purposes, you can specify it in the xsi:schemaLocation attribute. For a taglib.xml, specify the following schema in the xsi:schemaLocation attribute:

http://vdldoc.omnifaces.org https://raw.githubusercontent.com/omnifaces/vdldoc/master/src/main/resources/org/omnifaces/vdldoc/resources/vdldoc.taglib.xml.xsd

If want to specify the schema in you composite component .xhtml file, point to the .xsd for composite components instead as shown below:

http://vdldoc.omnifaces.org https://raw.githubusercontent.com/omnifaces/vdldoc/master/src/main/resources/org/omnifaces/vdldoc/resources/vdldoc-cc.xhtml.xsd