view release on metacpan or  search on metacpan

Changes  view on Meta::CPAN

                       Revision history for DocKnot

v8.0.1 - 2024-07-14

 - Fix formatting of Perl Changes files and possibly other text documents
   when formatting multiple documents with App::DocKnot::Spin::Text in the
   same process.  Some data about the documents had leaked from one
   document to the next.

 - Add the ".css" suffix to the style specified in *.spin pointers for
   Markdown files, matching the behavior of text and pod files.

 - Fix conversion of partial style sheet URLs in *.rpod and *.faq pointers
   to style sheet names in *.spin files during docknot update-spin.

v8.0.0 - 2024-07-07

 - DocKnot now uses semantic versioning for the package and modules, with
   a v prefix to work with Perl's packaging system.

 - Merge faq2html into this package as App::DocKnot::Spin::Text, and add a
   new command, docknot spin-text, which takes roughly the same options as
   faq2html.  This adds the ability to convert text files in my personal
   format into HTML.

 - Support *.spin pointers in addition to *.faq pointers for external text
   files.  *.faq files are deprecated and support will be removed in a
   future version of DocKnot.

 - Support version numbers prefixed with v in release tarball names, since
   this appears to be the convention for Perl modules that use semantic
   versions.

 - Change the docknot.yaml field orphaned to unmaintained, and change the
   templates to say the package is not maintained instead of orphaned.
   This terminology is more precise and less metaphorical.

 - Remove support information from the README.md and README templates for
   packages that are no longer maintained, and adjust some of the wording
   there and in the thread template.

 - Add missing </address> closing tag in pages rendered from Markdown.

 - Fix typo in README.md template for ExtUtils::MakeMaker packages.

 - Fix the URL in the footer added by docknot spin to point to DocKnot
   instead of my old web tools page.

7.01 - 2022-01-19

 - Correctly handle Unicode output from commands run by pointers and from
   POD processing by Pod::Thread.  Previous versions since 6.01 were
   double-encoding.  Thanks to Julien ÉLIE for the report.

 - Follow symlinks to ordinary files in docknot spin, just not
   directories.  The Path::Iterator::Rule conversion in 6.01 broke copying
   of files referenced by symlink.

 - The \size spin always used 1024-based units.  It now correctly uses the
   KiB, MiB, etc. abbreviations to match.

7.00 - 2022-01-17

 - Various module APIs now take Path::Tiny objects instead of string
   paths.  Roughly, any module API that is not called directly by
   App::DocKnot::Command now expects paths in the form of Path::Tiny
   objects and does not always do an explicit conversion.

 - Fix Unicode handling in App::DocKnot::Spin::Thread methods.  Output to
   files was handled correctly in most cases, but output to a scalar or to
   standard output was not, nor was output to a file when the input was
   generated by another program.

 - Fix processing of old-style pointers in docknot spin.

 - Fix import error when running docknot release.

 - Fix .versions updating via docknot release when the package that needs
   to be udpated is not the first line of the file.

 - When spinning an input tree, process all .rss files first in a separate
   pass.  This ensurse the output files are seen when spinning the tree
   into the output directory.

 - Ensure docknot dist always regenerates the *.tar.xz file if necessary,
   rather than reusing one left over from a previous build of the same
   version.

 - Always recreate GnuPG signatures when generating distribution tarballs
   in docknot dist.

 - When copying distribution files with docknot release, also copy the
   modification timestamps of those files.

6.01 - 2022-01-15

Changes  view on Meta::CPAN

   thread output.

 - Add bug tracker links pointing to the CPAN RT installation to the
   developer documentation links section of the thread template if
   support.cpan is set.

 - Output more helpful information about test failures on Windows and
   other systems that don't have the diff command.

2.00 - 2019-01-12

 - Move previous docknot command functionality to a new docknot generate
   subcommand.  All docknot actions in the future will be added as
   subcommands.

 - docknot generate now takes the name of the template as its first
   positional argument instead of as the -t option.

 - generate() and therefore the generate subcommand now defaults to
   looking for metadata in docs/metadata, and the -m option is now
   optional.

 - The -o option to docknot generate and the output argument to
   generate_output() is now optional if there is a default output file
   defined for the template.  The two defaults are README for the readme
   template and README.md for the readme-md template, both in the current
   directory.

 - Rename App::DocKnot to App::DocKnot::Generate and add a new
   generate_output() method that writes the generated output to a
   specified file instead of returning it as a string.  App::DocKnot must
   be loaded as well to use the module API.

 - Add new generate-all command and generate_all() method that generates
   all package documentation files with a default output file.

 - Separate the TESTING section from BUILD AND INSTALLATION for Perl
   modules in both README and README.md, and move the Lancaster
   instructions to that section.  Add instructions for how to run a single
   test with Perl build systems.  Test dependencies for Perl modules
   should now move into docs/metadata/test/suffix, the same as for
   packages with an Autoconf build system.

 - If build.lancaster is set to true, add the standard section on
   Lancaster consensus variables to the end of a TESTING section in README
   and README.md even when a custom testing section is provided in the
   metadata.

1.06 - 2018-08-31

 - When generating text output, put the footnotes containing URLs for
   links immediately following the containing paragraph rather than the
   end of the text block.  This is both more readable and avoids odd
   placement of the footnotes when a template adds further paragraphs to
   the end of a text block containing footnotes.

 - Do not wrap paragraphs in output that seem to be a bunch of short
   lines, and add support for broken quotes (multiple short lines, such as
   poetry) in quotes in the thread template.

 - Adjust the README and README.md template to say that make warnings
   requires either GCC or Clang, instead of only mentioning GCC.

 - Adjust the README.md wording for the list information URL when package
   releases are announced on a mailing list.

 - Add support for additional developer documentation links in the thread
   output template.

 - Add support for contributed program documentation links in the thread
   output template.

1.05 - 2018-05-05

 - Add the Travis-CI badge to README.md and a link to Travis-CI to the
   thread development links if the vcs.travis key is set in metadata.json.

 - Add a Shields.io badge for the CPAN version to README.md and a link to
   metacpan.org in the thread output if the distribution.cpan key is set
   in metadata.json.

 - Move the description of Lancaster Consensus environment variables into
   the testing section of README and README.md instead of the requirements
   section, since they're more about running the tests and less about
   package requirements in general.

 - Add support for a new packaging/extra metadata file (setting the
   packaging.extra key in templates) and use it in the thread template.

 - Correctly handle multi-paragraph debian.summary metadata in the thread
   template.

 - Fix formatting bug in the README template when additional bootstrap
   documentation is provided.

 - DocKnot now requires Perl 5.24 or later.

1.04 - 2018-03-24

 - Fix SPDX test failure on Windows.

1.03 - 2018-03-17

 - Add support for a new metadata file, support/extra, that includes
   information that should be added into the middle of the normal SUPPORT
   section of README and README.md files.

 - Add a paragraph to the license section of README and README.md saying
   that SPDX license identifiers are in use and providing a pointer to the
   SPDX license list.

 - Add SPDX-License-Identifier headers to all substantial source files,
   and add a test to check for them.

1.02 - 2017-12-31

 - Support quoted paragraphs (each line starting with ">") and turn them
   into indentation when turning markup into plain text.

 - Support numbered lists when converting to thread.