Marc Santhoff schrieb:
Nice idea, but before starting work remember that some things are
already invented.
All that does not help much in managing and editing the FPCDocs.
Roadmap:
I'm just about to show the help entries <element .../> in the XML docs,
that have been changed since the last inspection. A last step then would
be to show the same element in LazDE for editing (to come). Every
difference can be marked as done, and when all differences in one XML
file have been processed, the new file can replace the old one in the
secondary (backup) directory. For many changes, which can not be
processed in one run, it should be possible to save the ToDo list, with
all processed sections removed, or to save the backup file with all
processed sections updated (to come).
As a first test I use the docs for trunk and 0.9.30, which are not too
different. When starting from scratch, e.g. with a translation of the
docs, the secondary XML directory is empty and diff only reports missing
directories (e.g. lcl, fcl) in the backup. When such an entry is
selected, the user is asked whether the directory shall be created in
the secondary directory. In the next run diff will report missing files
in the created directory, with the option to create skeletons for every
selected file (to be implemented). In another run diff will report all
the (still empty) entries as different. Now the user can start to
translate or create otherwise different versions of the file, marking
all processed entries as above.
The tracker has a modular design now, with a general Diff and Document
class. From the Diff class currently an XMLDiff class is derived, which
removes all non-XML files from the ToDo list. From the Document class an
FPDocDoc class is derived, which maps the different lines to FPDoc
elements in the XML files, and invokes LazDE for editing entries. Other
derived classes can handle other document types, like units or wiki
files. Such trackers then can be used to e.g. track changes in the
examples directory, so that all (new) example projects can be linked to
the related FPDoc entries.
DoDi
--
_______________________________________________
Lazarus mailing list
Lazarus@lists.lazarus.freepascal.org
http://lists.lazarus.freepascal.org/mailman/listinfo/lazarus
