
	Where results make sense

Topic: Plain Old Documentation

	GNU Free Documentation License - GNU Project - Free Software Foundation (FSF)
		If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
		The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
		Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
	www.gnu.org /copyleft/fdl.html (2823 words)

	perlpodspec - Plain Old Documentation: format specification and notes
		Pod formatters should tolerate lines in verbatim blocks that are of any length, even if that means having to break them (possibly several times, for very long lines) to avoid text running off the side of the page.
		Pod parsers, when processing a series of verbatim paragraphs one after another, should consider them to be one large verbatim paragraph that happens to contain blank lines.
		Pod parsers, when processing a series of data paragraphs one after another (within a single region), should consider them to be one large data paragraph that happens to contain blank lines.
	cpan.uwinnipeg.ca /htdocs/Pod-Simple/perlpodspec.html (7657 words)

	Overview - Using Plain Old Documentation format in GP Perl code (Site not responding. Last check: )
		Pod is a very simple text markup format that can either be used on its own or interspersed within Perl code.
		Perl considers pod to be commentary; the pod translators consider code to be extraneous.
		Pod directives may be followed by ``arguments'' which they use in various ways depending on the directive.
	www.cfcl.com /vlb/Projects/Howto/POD/podoc.html (1273 words)

	perlpod - plain old documentation
		For, begin, and end let you include sections that are not interpreted as pod text, but passed directly to particular formatters.
		Pod translators usually will require paragraphs to be separated by completely empty lines.
		The best way to check your pod is to pass it through one or more translators and proofread the result, or print out the result and proofread that.
	www.washington.edu /perl5man/pod/perlpod.html (800 words)

	Plain Black, makers of WebGUI - Plain Old Documentation (POD) (Site not responding. Last check: )
		You can either mix POD with code, put the POD at the beginning of the file or put the POD at the end of the file.
		In WebGUI we use =head1 to denote a section of documentation, and =head2 to denote subroutines or methods, and =head3 to denote subroutine parameters.
		Be sure to leave white space before and after the POD or it won't render/parse properly.
	www.plainblack.com /pod?op=displayAccount (310 words)

	Plain Old Documentation - Wikipedia, the free encyclopedia
		POD is designed to be a simple, clean language with just enough syntax to be useful.
		POD is rarely read in the raw, although it is designed to be readable without the assistance of a formatting tool.
		POD files are written in an ASCII-compatible encoding, such as Latin-1 or Unicode.
	en.wikipedia.org /wiki/Plain_Old_Documentation (764 words)

	perlpodspec(1): Plain Old Documentation: format ... - Linux man page
		In other words, the Pod processing handler for ``head1'' will apply the same processing to "Did You Remember to C?`` that it would to an ordinary paragraph --- i.e., formatting codes (like ''C<...>") are parsed and presumably formatted appropriately, and whitespace in the form of literal spaces and/or tabs is not significant.
		Pod processors may silently tolerate this if the not-first ``=encoding'' lines are just duplicates of the first one (e.g., if there's a ``=use utf8'' line, and later on another ``=use utf8'' line).
		But Pod processors should complain if there are contradictory ``=encoding'' lines in the same document (e.g., if there is a ``=encoding utf8'' early in the document and ``=encoding big5'' later).
	www.die.net /doc/linux/man/man1/perlpodspec.1.html (7719 words)

	Tech Notes (Site not responding. Last check: )
		This quick and dirty technical documentation method is used for this document and many of the other tech notes on this web site.
		Notes are typed as plain ASCII text with certain, minimal standards for formatting.
		Particularly strong for extensive technical documentation projects with complicated formatting and graphics, more so if documentation will be published.
	www.marchansen.com /tn109 (986 words)

	Vexi - Visually Extensible XML Interfaces - PerlPod (Site not responding. Last check: )
		A Pod block starts with any command paragraph, so a "=pod" command is usually used just when you want to start a Pod block with an ordinary paragraph or a verbatim paragraph.
		Pod is just meant to be an idiot-proof common source for nroff, HTML, TeX, and other markup languages, as used for online documentation.
		Start your documentation with an empty line, a "=head1" command at the beginning, and end it with a "=cut" command and an empty line.
	wiki.vexi.org /PerlPod (2080 words)

	POD - Piece Of Data, Plain Old Documentation, Plain Old Dos, Power On Display, Problem Of the Day, Proof of Deposit, ...
		Print on demand (POD) is the process of storing a book in digital format, then printing and binding that book only when it is ordered by a customer.
		A C-style type: a fundamental type, enumerated type, a pointer to a POD type, or an array of POD types.
		A class, structure, or union can be a POD type if its non-static data members all have POD types.
	www.auditmypc.com /acronym/POD.asp (684 words)

	perlpod - plain old documentation
		A more readable, and perhaps more ``plain'' way is to use an alternate set of delimiters that doesn't require a ``>'' to be escaped.
		If you're going to put your pods at the end of the file, and you're using an __END__ or __DATA__ cut mark, make sure to put an empty line there before the first pod directive.
		It is still advised to pass it through one or more translators and proofread the result, or print out the result and proofread that.
	www.xav.com /perl/lib/Pod/perlpod.html (1128 words)

	perlpod - the Plain Old Documentation format - search.cpan.org (Site not responding. Last check: )
		Pod is a simple-to-use markup language used for writing documentation for Perl, Perl programs, and Perl modules.
		A more readable, and perhaps more "plain" way is to use an alternate set of delimiters that doesn't require a single ">" to be escaped.
		Many older Pod translators require the lines before every Pod command and after every Pod command (including "=cut"!) to be a blank line.
	search.cpan.org /~nwclark/perl-5.8.7/pod/perlpod.pod (2266 words)

	Perl Training Australia - Plain Old Documentation (POD)
		POD is designed to be a simple, clean documentation language.
		POD uses three kinds of paragraphs (text preceded by and followed by a blank line).
		Tells the POD formatter that this is the end of a section of POD and thus to stop.
	perltraining.com.au /tips/2005-04-06.html (754 words)

	Plain Old Documentation in 5 minutes - Juεrd's site (Site not responding. Last check: )
		I'll skip this section because any detailed discussion of why documentation is important would break my promise that you can learn to document in five minutes.
		If not, or if you use POD for other purposes than code documentation (it is a great format to write articles and reports in), it is your own choice.
		POD supports a small set of markup elements.
	juerd.nl /site.plp/perlpodtut (625 words)

	Virtual Solutions : Resources : Documentation : Perl POD : perlpodspec - Plain Old Documentation: format specification ...
		In parsing Pod, a notably tricky part is the correct parsing of.(potentially nested!) formatting codes.
		For example, while the paragraph you're reading now could be considered, in Pod source, to end with (and contain) the newline(s) that end it, it should be processed as ending with (and containing) the period character that ends this sentence.
		Pod parsers may also note additional attributes including:.
	www.monster-submit.com /resources/docs/pod/perlpodspec.html (7555 words)

	f90doc homepage (Site not responding. Last check: )
		A useful (but simple) documentation language that is easily readable with a text editor and convertable into HTML, supporting lists, bold, italic, and verbatim text.
		For a quick start, you can look at the Fortran 90 code and resulting HTML documentation for a simple example.
		Details on this and previous releases (including copies of all old versions).
	theory.lcs.mit.edu /~edemaine/f90doc (333 words)

	Writing Documentation - Part 1: POD LG #73
		Therefore, the source of the documentation should at least be amenable to standard searching tools like, for example, the grep family (grep, agrep, rgrep, sgrep) of tools.
		For documentation to be ``open'' (as in ``Open Source''), the source should be easy to read, and the system to generate the final output should be simple to learn.
		This means, the documenter simply writes one paragraph after the other with at least one blank line between each pair.
	linuxgazette.net /issue73/spiel.html (2013 words)

	podlators
		POD is the Plain Old Documentation format, the documentation language used for all of Perl's documentation.
		The former converts POD into nroff/troff source and the latter into plain text (with various options controlling some of the formatting).
		You therefore only need to install this package yourself if you have an old verison of Perl or need a newer version than came with Perl (to get some bug fixes, for example).
	www.eyrie.org /~eagle/software/podlators (434 words)

	Virtual Solutions : Resources : Documentation : Perl POD : perlpod - the Plain Old Documentation format
		Pod markup consists of three basic kinds of paragraphs: ``Ordinary Paragraph'', ``Verbatim Paragraph'', and ``Command Paragraph''.
		=cut To end a Pod block, use a blank line, then a line beginning with ``=cut'', and a blank line after it.
		=pod The ``=pod'' command by itself doesn't do much of anything, but it signals to Perl (and Pod formatters) that a Pod block starts here.
	www.monster-submit.com /resources/docs/pod/perlpod.html (2242 words)

	perl(1): Practical Extraction/Report Language - Linux man page
		The default configuration for perl will place this additional documentation in the /usr/local/lib/perl5/man directory (or else in the man subdirectory of the Perl library directory).
		Some of this additional documentation is distributed standard with Perl, but you'll also find documentation for third-party modules there.
		You should be able to view Perl's documentation with your man(1) program by including the proper directories in the appropriate start-up files, or in the
	www.die.net /doc/linux/man/man1/perl.1.html (1119 words)

	perlpodtut II \| Perl \| porters
		POD stands for Plain Old Documentation and is the formatting
		Large scale POD formatting issues like this are quite beyond its scope.
		POD is becoming rather widely used as a much easier way of generating man
	www.gossamer-threads.com /lists/perl/porters/189170 (5502 words)

	[No title]
		Please see the POD documentation for this module (embedded in the file "Parser.pm") for more details.
		Please see the POD documentation for this module (embedded in the file "Select.pm") and Pod::Parser for more details.
		Please see the POD documentation for this module (embedded in the file "Usage.pm") for more details.
	www.cpan.org /modules/by-authors/id/M/MA/MAREKR/Pod-Parser-1.34.readme (888 words)

	egghelp.org: netbots.tcl
		Enclosed scripts and documentation are in Unix file format and may not display correctly in Windows Notepad (try Wordpad or another text editor).
		Full plain text documentation is included in the above archives, but you may also access the formatted (easier to read) version of the documentation via the web:
		After you've read the documentation and loaded the script, don't forget to use the.nethelp command in DCC, which explains all the commands available in netbots.tcl.
	www.egghelp.org /netbots (493 words)

	PerlDocPlugin < Plugins < TWiki (Site not responding. Last check: )
		This Plugin extracts the Perl documentation (POD) from a Perl module located in the @INC library path and displays it in a topic.
		Keep in mind that this markup gets parsed correctly only by the PerlDocPlugin, other POD translator ignore the block.
		Set SHORTDESCRIPTION = Extract the Perl documentation (POD) from a Perl module and display it in a topic.
	twiki.org /cgi-bin/view/Plugins/PerlDocPlugin (268 words)

	perlpod - the Plain Old Documentation format
		"=end :formatname"), to signal that the text is not raw data, but instead is Pod text (i.e., possibly containing formatting codes) that's just not for normal formatting (e.g., may not be a normal-use paragraph, but might be for formatting as a footnote).
		Otherwise number is interpreted as being in decimal, as in E<181>.Note that older Pod formatters might not recognize octal or hex numeric escapes, and that many formatters cannot reliably render characters above 255.
		Some older Pod translators require paragraphs (including command paragraphs like "=head2 Functions") to be separated by completelyempty lines.
	www.rblasch.org /projects/pod-input/perlpod.html (2379 words)

	ASPN : Module documentation (Site not responding. Last check: )
		The old requirement (0.09 and earlier) is supported for backward compatibility.
		Don't forget to add documentation for your command-line options and remove old documentation for any you removed.
		A current copy of the source code and documentation may be found at http://www.webfetch.org/
	aspn.activestate.com /ASPN/CodeDoc/WebFetch/WebFetch.html (4256 words)

	Tools
		The FreeBSD documentation is being migrated to DocBook.
		KDE is migrating all its documentation to DocBook SGML.
		It is already the format for all new documentation (LinuxDoc SGML is not used any longer).
	www.oasis-open.org /docbook/tools/index.shtml (216 words)

	Steve's place - Perl Tutorial Lesson 8
		Then you find a big old bug in the code you've merrily pasted into forty scripts, and spend a day finding all occurrences of the bug to fix them.
		Perl documentation is written in POD (plain old documentation) format, which is a markup language like HTML, but simpler.
		Documentation is extremely important: if you have a memory like mine, you won't remember how to use your own scripts in six month's time, so write the documentation now, so you don't have to remember the entire script later.
	www.steve.gb.com /perl/lesson08.html (4088 words)

	man: perl
		If you're new to Perl, you should start with perlintro, which is a gen- eral intro for beginners and provides some background to help you navi- gate the rest of Perl's extensive documentation.
		The default configuration for perl will place this additional documentation in the /usr/local/lib/perl5/man directory (or else in the man subdirec- tory of the Perl library directory).
		You should be able to view Perl's documentation with your man(1) pro- gram by including the proper directories in the appropriate start-up files, or in the MANPATH environment variable.
	www.hmug.org /man/1/perl.php (1115 words)

Try your search on: Qwika (all wikis)