I have a fair sized application to provide documentation and help files for.

The apps has a feature that makes every label on any form have "hover title" info and help text when you click on it. Given that I have 15 pages with 1 to 5 tabs and 4 to 40 labels I have a large task of keeping track of each of the pieces of help text.

My intent is to produce several target files from the one source file eg. Reference manuel and input file to the help system. I tried out POD on its own and I am running into problem with the number of levels of =head is limited to 4. The alternative is to use the =over =item =back features. I found was typing a lot of repeated text to structure the document and it was taking a long time to do.

I started to think about using text::autoformat to help produce pod text from an indented file. I have no experience with this module and I don't know it is even possible.

Now I am not sure what to do. While typing this question I wondered if there are any data dictionary programs that could keep the tree structure organized and allow anyone to do the input. I could write the programs to do the output.

Has anyone delt with this before.

Disclaimer I like from another Perlmonk.

In reply to Need advise on documentation support tools in Perl by admiraln

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.