Design
pod is designed to be a simple, clean language with just enough syntax to be useful. It purposefully does not include mechanisms for fonts, images, colors or tables. Some of its goals are:
- Easy to parse
- Easy to convert to other formats, such as XML or TeX
- Easy to incorporate sample code
- Easy to read without a pod formatter (i.e. in its source-code form)
- Easy to write in—otherwise programmers won't write the documentation!
An extended version of pod that supports tables and footnotes called PseudoPOD has been used by O'Reilly & Associates to produce several Perl books, most notably Programming Perl by Larry Wall, Tom Christiansen, and Jon Orwant. Mark Jason Dominus used a modified version called mod to write Higher-Order Perl.
pod makes it easy to write manual pages, which are well suited to user-oriented documents. In contrast, other documentation systems, such as Python's Docstring or Java's Javadoc, though can be used for user documentation, are designed to facilitate generating developer-oriented documentation about the source code for a software project.
Read more about this topic: Plain Old Documentation
Famous quotes containing the word design:
“For I choose that my remembrances of him should be pleasing, affecting, religious. I will love him as a glorified friend, after the free way of friendship, and not pay him a stiff sign of respect, as men do to those whom they fear. A passage read from his discourses, a moving provocation to works like his, any act or meeting which tends to awaken a pure thought, a flow of love, an original design of virtue, I call a worthy, a true commemoration.”
—Ralph Waldo Emerson (1803–1882)
“Nowadays the host does not admit you to his hearth, but has got the mason to build one for yourself somewhere in his alley, and hospitality is the art of keeping you at the greatest distance. There is as much secrecy about the cooking as if he had a design to poison you.”
—Henry David Thoreau (1817–1862)