f71c7a8032
Change the generated config option documentation to use the DX-friendly names defined for the configurator UI (instead of the XML element name hierarchy previously used). Options are grouped by the top-level section (aka complex type) they belong to and then sorted alphabetically with these groups. Use badges to indicate where options can be found in the configurator UI and whether they're applicable to the Hypervisor or Pre/Post/Service VM. Add a custom css style for the config-option doc that puts the first paragraph of a glossary item on the same line as the glossary term so these badges look pretty. Added a acrn-custom.js patch that copies the alt text for images into a title property for images within the config-doc document. This provides tooltip text when hovering over the badges. Don't display options not visible in the configurator UI (elements with acrn:views=""). A missing acrn:views or acrn:applicable-vm means we look for an applicable value from an ancestor element. Add processing of a second xs:documentation element within an xs:annotation element. This second documentation element's content will be appended as a new paragraph to the first xs:documentation content in the generated documentation. Only the first xs:documentation element is used by the Configurator for its tooltips. Update documents that were referring to options by their XML names. Because we're now using a glossary to provide links to config options, we can't duplicate option names or glosary names anywhere in the doc set. Signed-off-by: David B. Kinder <david.b.kinder@intel.com> |
||
|---|---|---|
| .. | ||
| Advanced.svg | ||
| Basic.svg | ||
| Hypervisor.svg | ||
| Not-available.svg | ||
| Post-launched-VM.svg | ||
| Pre-launched-VM.svg | ||
| README | ||
| Service-VM.svg | ||
README
These icon badges were created using https://shields.io static badges. Standard colors were used except for the Hypervisor #69BFAD (acrn-lightgreen) and post-launched VM #998265 (acrn-brown) colors defined in the acrn-custom.css