Use perldoc for documentation
Registered by
seattlegaucho
Initially the documentation should be implemented with perldoc
Blueprint information
- Status:
- Started
- Approver:
- seattlegaucho
- Priority:
- Medium
- Drafter:
- seattlegaucho
- Direction:
- Approved
- Assignee:
- seattlegaucho
- Definition:
- Approved
- Series goal:
- Accepted for trunk
- Implementation:
-
Good progress
- Milestone target:
- None
- Started by
- seattlegaucho
- Completed by
Whiteboard
Use perldoc to write the initial documentation and redirect its output to "manual.txt". In future releases we can add other alternative like HTML docs.
Using "perldoc" to create HTML doc produces reasonable formating but has no index in the header.
Using "perltidy" to create HTML doc creates the header index, but it has a couple of bugs coming from "pod2html" -> the <pre> (indented paragraphs with examples) format breaks formating for the paragraphs following it.
Current command lines:
To create man page: "perldoc -dmanual.txt mysar.pl"
To create html page: "perldoc -dmanual.html -ohtml mysar.pl"
(?)
