Vulkan-Docs/config
Jon Leech 56e0289318 Change log for January 05, 2019 Vulkan 1.1.97 spec update:
* Update release number to 97.

Public Issues:

  * Add a special case to the <<renderpass-compatibility, Render Pass
    Compatibility>> rules allowing single-subpass renderpasses to be
    compatible even if they have different resolve attachment references
    (public issue 835).
  * Fix the miss shader binding table record address rule in the
    <<shader-binding-table-indexing-rules, Miss Shaders>> section to index
    by code:missIndex, not code:sbtOffset (public issue 875).

Internal Issues:

  * Add a missing anchor to the elink:VkSamplerCreateFlagBits language
    (internal issue 1483).
  * Add missing implicit valid usage include for slink:VkHdrMetadataEXT and
    corresponding `noautovalidity` attributes in `vk.xml` for the
    externally-defined metadata properties (internal issue 1514).
  * Remove restrictions on the `mask` parameter of SPIR-V's
    code:OpGroupNonUniformXor in the <<spirvenv-module-validation,
    Validation Rules within a Module>> appendix (internal merge request
    2971).
  * Restore `noautovalidity` attribute for
    slink:VkPipelineViewportWScalingStateCreateInfoNV::pname:pViewportWScalings
    in `vk.xml` (internal merge request 2975).
  * Update copyright dates on Khronos-copyrighted files to 2019 (internal
    merge request 2980).

New Extensions:

  * `VK_KHR_depth_stencil_resolve`
  * `VK_EXT_buffer_device_address`
  * `VK_EXT_memory_budget`
  * `VK_EXT_memory_priority`
  * `VK_EXT_validation_features`
2019-01-05 19:40:12 -08:00
..
extension-highlighter Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
katex_replace Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
themes Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
vu-to-json Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
vulkan-macros Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
.gitignore Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
README.md Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
asciidoctor-mathematical-ext.rb Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
attribs.txt Fixed typos 2018-11-16 19:42:02 +01:00
extension-highlighter.rb Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
katex_replace.rb Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
khronos.css Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
makeSubmit.py Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
mathtest.txt Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
optimize-pdf Fix links in PDF build (#879) 2018-12-16 20:13:47 -08:00
tilde_open_block.rb Restructure the repository to put the specification Makefile and 2018-04-04 23:08:43 -07:00
vu-to-json.rb Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00
vulkan-macros.rb Change log for January 05, 2019 Vulkan 1.1.97 spec update: 2019-01-05 19:40:12 -08:00

README.md

Vulkan Asciidoc Configuration Files

Macros

The macros in vulkan-macros.rb and vulkan-macros/extension.rb are described in the "Vulkan Documentation and Extensions: Procedures and Conventions" document (see the styleguide).

Support for Math

Asciidoctor is customized to insert KaTeX <script> tags from math.js for HTML5, and properly pass through math which has \begin{}\/end{} delimiters instead of [].

For PDF builds, asciidoctor-mathematical is used to generate

math-docbook.conf is heavily conditionalized depending on whether the final output format (which should be described in the a2x-format variable) is pdf or not, since Docbook passes through math differently to dblatex vs. the XHTML stylesheets. This could be simplified now that we're only using Docbook for PDFs.

Stylesheets

khronos.css is the stylesheet used for HTML output.