Pod::Thread

Blurb

Pod::Thread translates POD source into thread, a macro language processed by spin. It supports optionally adding a table of contents and a navigation bar to the genenerated file. This package also includes the pod2thread driver script, invoked automatically by spin for POD files and pointers to POD files.

Description

This package contains a module to translate POD into thread, an HTML macro language. As such, it's not very useful without spin, a separate program to convert thread into HTML. I wrote this module for my personal needs and it may not be (and in fact probably isn't) suitable for more general use as yet.

The eventual intention is to incorporate spin into DocKnot, at which point this module will provide the POD support for DocKnot as a static site generator. I have no estimate for when that work will be done.

The conversion done by this module is mostly straightforward. The only notable parts are the optional generation of a table of contents or a navigation bar at the top of the generated file.

Requirements

Perl 5.24 or later and Pod::Parser 3.06 or later. As mentioned above, it's also not particularly useful without spin.

Download

The distribution:

Pod::Thread 2.00 2021-03-28 tar.gz (PGP signature) tar.xz (PGP signature)

An archive of older releases is also available.

A Debian package (libpod-thread-perl) is available from my personal repository.

Pod::Thread is available from CPAN as the Pod-Thread distribution.

Pod::Thread is maintained using the Git version control system. To check out the current development tree, see GitHub or clone:

    https://git.eyrie.org/web/pod-thread.git

Pull requests on GitHub are welcome. You can also browse the current development source.

Documentation

User documentation:

Developer documentation:

API documentation:

License

The Pod::Thread package as a whole is covered by the following copyright and license:

Copyright 2002, 2008-2009, 2013, 2021 Russ Allbery <rra@cpan.org>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), 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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN 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.

Some individual source files are covered by other, compatible licenses. For complete copyright and license information, see the file LICENSE in the Pod::Thread source distribution.

Last modified and spun 2021-03-28