| < DocKnot | Russ Allbery > Software | Web Tools > |
Pod::Thread translates POD source into thread, a macro language processed by DocKnot. It supports optionally adding a table of contents and a navigation bar to the genenerated file. This package also includes the pod2thread driver script for easy command-line access to the converter.
This package contains a module to translate POD into thread, an HTML macro language. As such, it is primarily intended to support DocKnot, the static site generator that converts thread into HTML. Pod::Thread provides the POD formatting for DocKnot.
DocKnot and this module were written for my personal needs and may not be suitable for more general use.
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.
Perl 5.24 or later. As mentioned above, it's also not particularly useful without DocKnot.
The distribution:
| Pod::Thread 3.01 | 2021-12-26 | tar.gz (PGP signature) | tar.xz (PGP signature) |
An archive of older releases is also available.
Pod::Thread is packaged for Debian as libpod-thread-perl. See the Debian package tracker for more information.
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.
User documentation:
Developer documentation:
API documentation:
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.
| < DocKnot | Russ Allbery > Software | Web Tools > |