.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" 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::Spin::Pointer 3pm" .TH App::DocKnot::Spin::Pointer 3pm "2023-11-19" "perl v5.36.0" "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::Spin::Pointer \- Generate HTML from a pointer to an external file .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& use App::DocKnot::Spin::Pointer; \& use App::DocKnot::Spin::Sitemap; \& use Path::Tiny qw(path); \& \& my $sitemap_path = path(\*(Aq/input/.sitemap\*(Aq); \& my $sitemap = App::DocKnot::Spin::Sitemap\->new($sitemap_path); \& my $pointer = App::DocKnot::Spin::Pointer\->new({ \& output => path(\*(Aq/output\*(Aq), \& sitemap => $sitemap, \& }); \& my $input = path(\*(Aq/input/file.spin\*(Aq); \& my $output = path(\*(Aq/output/file.html\*(Aq); \& $pointer\->spin_pointer($input, $output); .Ve .SH "REQUIREMENTS" .IX Header "REQUIREMENTS" Perl 5.24 or later and the modules File::ShareDir, Kwalify, List::SomeUtils, Path::Tiny, Pod::Thread, and \s-1YAML::XS,\s0 all of which are available from \s-1CPAN.\s0 .SH "DESCRIPTION" .IX Header "DESCRIPTION" The tree of input files for App::DocKnot::Spin may contain pointers to external files in various formats. These files are in \s-1YAML\s0 format and end in \&\f(CW\*(C`.spin\*(C'\fR. This module processes those files and converts them to \s-1HTML\s0 and, if so configured, adds the links to integrate the page with the rest of the site. .PP For the details of the pointer file format, see \*(L"\s-1POINTER FILES\*(R"\s0 below. .SH "CLASS METHODS" .IX Header "CLASS METHODS" .IP "new(\s-1ARGS\s0)" 4 .IX Item "new(ARGS)" Create a new App::DocKnot::Spin::Pointer object. A single converter object can be used repeatedly to convert pointers in a tree of files. \s-1ARGS\s0 should be a hash reference with one or more of the following keys, all of which are optional: .RS 4 .IP "output" 4 .IX Item "output" The path to the root of the output tree when converting a tree of files. This will be used to calculate relative path names for generating inter-page links using the provided \f(CW\*(C`sitemap\*(C'\fR argument. If \f(CW\*(C`sitemap\*(C'\fR is given, this option should also always be given. .IP "sitemap" 4 .IX Item "sitemap" An App::DocKnot::Spin::Sitemap object. This will be used to create inter-page links. For inter-page links, the \f(CW\*(C`output\*(C'\fR argument must also be provided. .IP "style-url" 4 .IX Item "style-url" The base \s-1URL\s0 for style sheets. A style sheet specified in a pointer file will be considered to be relative to this \s-1URL\s0 and this \s-1URL\s0 will be prepended to it. If this option is not given, the name of the style sheet will be used verbatim as its \s-1URL,\s0 except with \f(CW\*(C`.css\*(C'\fR appended. .IP "thread" 4 .IX Item "thread" An App::DocKnot::Spin::Thread object, used for converting \s-1POD\s0 into \s-1HTML.\s0 It should be configured with the same App::DocKnot::Spin::Sitemap object as the \&\f(CW\*(C`sitemap\*(C'\fR argument. .RE .RS 4 .RE .SH "INSTANCE METHODS" .IX Header "INSTANCE METHODS" .IP "is_out_of_date(\s-1POINTER, OUTPUT\s0)" 4 .IX Item "is_out_of_date(POINTER, OUTPUT)" Returns true if \s-1OUTPUT\s0 is missing or if it was modified less recently than the modification time of either \s-1POINTER\s0 or the underlying file that it points to. Both paths must be Path::Tiny objects. .IP "spin_pointer(\s-1POINTER, OUTPUT\s0)" 4 .IX Item "spin_pointer(POINTER, OUTPUT)" Convert a single pointer file to \s-1HTML.\s0 \s-1POINTER\s0 is the path to the pointer file, and \s-1OUTPUT\s0 is the path to where to write the output. Both paths must be Path::Tiny objects. .SH "POINTER FILES" .IX Header "POINTER FILES" A pointer file is a \s-1YAML\s0 file ending in \f(CW\*(C`.spin\*(C'\fR that points to the source file for a generated \s-1HTML\s0 page and provides additional configuration for its conversion. The valid keys for a pointer file are: .IP "format" 4 .IX Item "format" The format of the source file. Supported values are \f(CW\*(C`markdown\*(C'\fR and \f(CW\*(C`pod\*(C'\fR. Required. .IP "path" 4 .IX Item "path" The path to the source file. It may be relative, in which case it's relative to the pointer file. Required. .IP "options" 4 .IX Item "options" Additional options that control the conversion to \s-1HTML.\s0 These will be different for each supported format. .Sp \&\f(CW\*(C`markdown\*(C'\fR has no supported options. .Sp The supported options for a format of \f(CW\*(C`pod\*(C'\fR are: .RS 4 .IP "contents" 4 .IX Item "contents" Boolean saying whether to generate a table of contents. The default is false. .IP "navbar" 4 .IX Item "navbar" Boolean saying whether to generate a navigation bar at the top of the page. The default is true. .RE .RS 4 .RE .IP "style" 4 .IX Item "style" The style sheet to use for the converted output. Optional. If not set, converted \f(CW\*(C`markdown\*(C'\fR output will be unstyled and converted \f(CW\*(C`pod\*(C'\fR output will use a style sheet named \f(CW\*(C`pod\*(C'\fR. .IP "title" 4 .IX Item "title" The title of the converted page. Optional. If not set, the title will be taken from the converted file in a format-specific way. For Markdown, the title will be the contents of the first top-level heading. For \s-1POD,\s0 the title will be taken from a \s-1NAME\s0 section formatted according to the conventions for manual pages. .SH "AUTHOR" .IX Header "AUTHOR" Russ Allbery .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 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::Spin, App::DocKnot::Spin::Sitemap .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 .