doctools::changelog(n) 0.1 "Documentation tools"

NAME

doctools::changelog - Handle text in Emacs ChangeLog format

This package provides tcl commands which are able to process and reformat text in the "ChangeLog" format generated emacs.

::doctools::changelog::scan text: The command takes the text, parses it under the assumption that it contains a ChangeLog as generated by emacs and returns a data structure describing this ChangeLog.

This data structure is a list whose elements describe one entry in the ChangeLog each. Each entry is a list of three elements describing date of the entry, its author, and the comments made, in this order. The last element of each entry, the comments, is a list of sections. Each section is described by two elements, a list of file names, and a string containing the true comment associated with the files of the section.
::doctools::changelog::toDoctools title module version entries: This command converts the pre-parsed ChangeLog entries (as generated by ::doctools::changelog::scan) into a document in doctools format and returns it as the result of the command.

The other three arguments supply information for the header of that document which is not available from the changelog itself.
::doctools::changelog::merge entries...: Each argument of the command is assumed to be a pre-parsed Changelog as generated by ::doctools::changelog::scan). The command merges all of them into a single structure, collapsing multiple entries for the same date and author into a single entry. The new structure is returned as the result of the command.