Re: 3.15.1 documentation...

[Andrew Johnson <anj@aps.anl.gov>]

Hi David,

On 02/20/2015 12:56 PM, Dudley, David wrote:
> Has any of the documentation on the wiki been updated to begin
> reflecting the additional capabilities of 3.15.1?

Instead of using the Wiki we've started to include the documentation for
each record type in the record.dbd files using Perl's POD format, from
where we can automatically extract the information for the field
description tables and generate a separate HTML file for each record
type. The necessary tools to do that are included in 3.15.1, but if you
look in your base-3.15.1/html directory you'll see that we haven't got
terribly far through the list of records yet. Unfortunately the manual
conversion and update process is rather boring since I started (with the
ai and ao records) doing major rewrites of their descriptions to remove
cruft and make the text more useful.

I should probably put something on the Wiki explaining all this.

I would be very happy for any help the community can offer to this
project, but I am looking for the record descriptions to be rewritten to
match the current code and some additional sections added, not just the
conversion of the current Wiki pages into POD format.

- Andrew
-- 
Doctorow's Law: Anytime someone puts a lock on something you own,
    against your wishes, and doesn't give you the key, they're
    not doing it for your benefit.