1doctools::changelog(n) Documentation tools doctools::changelog(n)
2______________________________________________________________________________
6
8 doctools::changelog - Processing text in Emacs ChangeLog format
9
11 package require Tcl 8.2
12 package require textutil
14 package require doctools::changelog ?1.1?
16 ::doctools::changelog::scan text
18 ::doctools::changelog::flatten entries
20 ::doctools::changelog::toDoctools title module version entries
22 ::doctools::changelog::merge entries...
24______________________________________________________________________________
26
28 This package provides Tcl commands for the processing and reformatting
29 of text in the "ChangeLog" format generated by emacs.
30
32 ::doctools::changelog::scan text
33 The command takes the text and parses it under the assumption
34 that it contains a ChangeLog as generated by emacs. It returns a
35 data structure describing the contents of this ChangeLog.
36 This data structure is a list where each element describes one
38 entry in the ChangeLog. Each element/entry is then a list of
39 three elements describing the date of the entry, its author, and
40 the comments made, in this order. The last item in each ele‐
41 ment/entry, the comments, is a list of sections. Each section is
42 described by a list containing two elements, a list of file
43 names, and a string containing the true comment associated with
44 the files of the section.
45 {
49 {
50 date
51 author
52 {
53 {
54 {file ...}
55 commenttext
56 }
57 ...
58 }
59 }
60 {...}
61 }
62 ::doctools::changelog::flatten entries
65 This command converts a list of entries as generated by
66 change::scan above into a simpler list of plain text blocks each
67 containing all the information of a single entry.
68 ::doctools::changelog::toDoctools title module version entries
70 This command converts the pre-parsed ChangeLog entries as gener‐
71 ated by the command ::doctools::changelog::scan into a document
72 in doctools format and returns it as the result of the command.
73 The other three arguments supply the information for the header
75 of that document which is not available from the changelog it‐
76 self.
77 ::doctools::changelog::merge entries...
79 Each argument of the command is assumed to be a pre-parsed
80 Changelog as generated by the command ::doc‐
81 tools::changelog::scan. This command merges all of them into a
82 single structure, and collapses multiple entries for the same
83 date and author into a single entry. The new structure is re‐
84 turned as the result of the command.
85
87 This document, and the package it describes, will undoubtedly contain
88 bugs and other problems. Please report such in the category doctools
89 of the Tcllib Trackers [http://core.tcl.tk/tcllib/reportlist]. Please
90 also report any ideas for enhancements you may have for either package
91 and/or documentation.
92 When proposing code changes, please provide unified diffs, i.e the out‐
94 put of diff -u.
95 Note further that attachments are strongly preferred over inlined
97 patches. Attachments can be made by going to the Edit form of the
98 ticket immediately after its creation, and then using the left-most
99 button in the secondary navigation bar.
100
102 changelog, doctools, emacs
103
105 Documentation tools
106
108 Copyright (c) 2003-2013 Andreas Kupries <andreas_kupries@users.sourceforge.net>
109tcllib 1.1 doctools::changelog(n)