Repo to revise Rakudoc standard
The Gamma review process is scheduled to last until 1 November 2023.
On its first meeting after 1 November, the Raku Steering Council will decide whether to prolong the Gamma review, or to adopt the standard as laid out in this document.
Some history and goals of the revision can be found at Revising Rakudoc.
Comments, patches, enhancement requests are welcomed. The following goals should be considered when making such suggestions:
- RakuDoc is intended to be backwards compatible with POD6, meaning that anything would be legal in RakuDoc would also be legal in POD6.
- POD6 is defined here as being in the document
Raku/docs/doc/language/pod6.rakudoc
- POD6 is defined here as being in the document
- Some parts of the document use work-arounds in examples, these will be revised once a renderer is available to handle examples properly.
An online HTML rendering of the current document is visible at new-raku
The renderer for the online version is currently being actively developed to provide the functionality defined in the RakuDoc document itself. Consequently, the document here has examples shown using workarounds.
Known deficiencies in Raku::Pod::Render:
:numberedis not recognisedP<>is incomplete for several schemes, andsemantic:can only handle backward references=aliasandA<>are not implementedD<>is not correctly implementedL<|#defn: ...>is not implemented for eitherD<>or=defn=configmetadata is passed to templates, but the default templates do not handle the data yet=config Qwhere Q is some markup instruction is not yet fully implementedDOC useis not recognised.
Raku::Pod::Render has some extensions that are not a part of standared Rakudoc, including
- AUTHOR SUMMARY VERSION DESCRIPTION are automatically given the metadata option
:hiddenand included in the<head>block of HTML as meta tabs.