1doctools::changelog(n)        Documentation tools       doctools::changelog(n)
2
3
4
5______________________________________________________________________________
6

NAME

8       doctools::changelog - Processing text in Emacs ChangeLog format
9

SYNOPSIS

11       package require Tcl  8.2
12
13       package require textutil
14
15       package require doctools::changelog  ?1?
16
17       ::doctools::changelog::scan text
18
19       ::doctools::changelog::toDoctools title module version entries
20
21       ::doctools::changelog::merge entries...
22
23_________________________________________________________________
24

DESCRIPTION

26       This  package provides Tcl commands for the processing and reformatting
27       of text in the "ChangeLog" format generated by emacs.
28

API

30       ::doctools::changelog::scan text
31              The command takes the text and parses it  under  the  assumption
32              that it contains a ChangeLog as generated by emacs. It returns a
33              data structure describing the contents of this ChangeLog.
34
35              This data structure is a list where each element  describes  one
36              entry  in  the  ChangeLog.  Each element/entry is then a list of
37              three elements describing the date of the entry, its author, and
38              the  comments  made,  in  this order. The last item in each ele‐
39              ment/entry, the comments, is a list of sections. Each section is
40              described  by  a  list  containing  two elements, a list of file
41              names, and a string containing the true comment associated  with
42              the files of the section.
43
44
45                  {
46                   {
47                       date
48                       author
49                       {
50                        {
51                            {file ...}
52                            commenttext
53                        }
54                        ...
55                       }
56                   }
57                   {...}
58                  }
59
60
61       ::doctools::changelog::toDoctools title module version entries
62              This command converts the pre-parsed ChangeLog entries as gener‐
63              ated by the command ::doctools::changelog::scan into a  document
64              in doctools format and returns it as the result of the command.
65
66              The  other three arguments supply the information for the header
67              of that document which  is  not  available  from  the  changelog
68              itself.
69
70       ::doctools::changelog::merge entries...
71              Each  argument  of  the  command  is  assumed to be a pre-parsed
72              Changelog    as    generated    by    the     command     ::doc‐
73              tools::changelog::scan.  This  command merges all of them into a
74              single structure, and collapses multiple entries  for  the  same
75              date  and  author  into  a  single  entry.  The new structure is
76              returned as the result of the command.
77

BUGS, IDEAS, FEEDBACK

79       This document, and the package it describes, will  undoubtedly  contain
80       bugs  and  other problems.  Please report such in the category doctools
81       of       the       Tcllib       SF       Trackers       [http://source‐
82       forge.net/tracker/?group_id=12883].   Please  also report any ideas for
83       enhancements you may have for either package and/or documentation.
84

KEYWORDS

86       changelog, doctools, emacs
87

89       Copyright (c) 2003-2008 Andreas Kupries <andreas_kupries@users.sourceforge.net>
90
91
92
93
94doctools                               1                doctools::changelog(n)
Impressum