.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "App::DocKnot::Generate 3pm" .TH App::DocKnot::Generate 3pm "2021-02-27" "perl v5.32.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" App::DocKnot::Generate \- Generate documentation from package metadata .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 7 \& use App::DocKnot::Generate; \& my $docknot \& = App::DocKnot::Generate\->new({ metadata => \*(Aqdocs/docknot.yaml\*(Aq }); \& my $readme = $docknot\->generate(\*(Aqreadme\*(Aq); \& my $index = $docknot\->generate(\*(Aqthread\*(Aq); \& $docknot\->generate_output(\*(Aqreadme\*(Aq); \& $docknot\->generate_output(\*(Aqthread\*(Aq, \*(Aqwww/index.th\*(Aq) .Ve .SH "REQUIREMENTS" .IX Header "REQUIREMENTS" Perl 5.24 or later and the modules File::BaseDir, File::ShareDir, Kwalify, Template (part of Template Toolkit), and \s-1YAML::XS,\s0 all of which are available from \s-1CPAN.\s0 .SH "DESCRIPTION" .IX Header "DESCRIPTION" This component of DocKnot provides a system for generating consistent human-readable software package documentation from metadata files, primarily \&\s-1JSON\s0 and files containing documentation snippets. It takes as input a directory of metadata and a set of templates and generates a documentation file from the metadata given the template name. .PP The path to the metadata directory for a package is given as an explicit argument to the App::DocKnot::Generate constructor. All other data (currently templates and license information) is loaded via File::BaseDir and therefore uses \s-1XDG\s0 paths by default. This means that templates and other global configuration are found by searching the following paths in order: .IP "1." 4 \&\fI\f(CI$HOME\fI/.config/docknot\fR .IP "2." 4 \&\fI\f(CI$XDG_CONFIG_DIRS\fI/docknot\fR (\fI/etc/xdg/docknot\fR by default) .IP "3." 4 Files included in the package. .PP Default templates and license files are included with the App::DocKnot module and are used unless more specific configuration files exist. .SH "CLASS METHODS" .IX Header "CLASS METHODS" .IP "new(\s-1ARGS\s0)" 4 .IX Item "new(ARGS)" Create a new App::DocKnot::Generate object. This should be used for all subsequent actions. \s-1ARGS\s0 should be a hash reference with one or more of the following keys: .RS 4 .IP "metadata" 4 .IX Item "metadata" The path to the directory containing metadata for a package. Default: \&\fIdocs/docknot.yaml\fR relative to the current directory. .IP "width" 4 .IX Item "width" The wrap width to use when generating documentation. Default: 74. .RE .RS 4 .RE .SH "INSTANCE METHODS" .IX Header "INSTANCE METHODS" .IP "generate(\s-1TEMPLATE\s0)" 4 .IX Item "generate(TEMPLATE)" Load the metadata from the path given in the constructor and generate the documentation file defined by \s-1TEMPLATE,\s0 which is the name of a template. The template itself will be loaded from the App::DocKnot configuration path as described in \s-1DESCRIPTION\s0. Returns the generated documentation file as a string. .IP "\fBgenerate_all()\fR" 4 .IX Item "generate_all()" Generate all of the documentation files for a package. This is currently defined as the \f(CW\*(C`readme\*(C'\fR and \f(CW\*(C`readme\-md\*(C'\fR templates. The output will be written to the default output locations, as described under \fBgenerate_output()\fR. .IP "generate_output(\s-1TEMPLATE\s0 [, \s-1OUTPUT\s0])" 4 .IX Item "generate_output(TEMPLATE [, OUTPUT])" The same as \fBgenerate()\fR except that rather than returning the generated documentation file as a string, it will be written to the file named by \&\s-1OUTPUT.\s0 If that argument isn't given, a default based on the \s-1TEMPLATE\s0 argument is chosen as follows: .Sp .Vb 2 \& readme \-> README \& readme\-md \-> README.md .Ve .Sp If \s-1TEMPLATE\s0 isn't one of the templates listed above, the \s-1OUTPUT\s0 argument is required. .SH "AUTHOR" .IX Header "AUTHOR" Russ Allbery .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2013\-2021 Russ Allbery .PP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \*(L"Software\*(R"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: .PP The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. .PP \&\s-1THE SOFTWARE IS PROVIDED \*(L"AS IS\*(R", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\s0 \s-1IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBdocknot\fR\|(1), App::DocKnot::Config .PP This module is part of the App-DocKnot distribution. The current version of DocKnot is available from \s-1CPAN,\s0 or directly from its web site at .