X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=pod%2Fperlpodspec.pod;h=8973a7080cde2c6fc5e8e97390a8b45cb85cc58c;hb=5b7d14ffe3988c7f70fd9dc76be9c44168d17a62;hp=0b60dfd967c4d536ac82551b675a1baf84bed6c5;hpb=75f15e9f00f368613ca4c59248fc2f6b4315911c;p=p5sagit%2Fp5-mst-13.2.git diff --git a/pod/perlpodspec.pod b/pod/perlpodspec.pod index 0b60dfd..8973a70 100644 --- a/pod/perlpodspec.pod +++ b/pod/perlpodspec.pod @@ -65,7 +65,7 @@ directly formatting it). A B (or B) is a module or program that converts Pod to some other format (HTML, plaintext, TeX, PostScript, RTF). A B might be a formatter or translator, or might be a program that does something -else with the Pod (like wordcounting it, scanning for index points, +else with the Pod (like counting words, scanning for index points, etc.). Pod content is contained in B. A Pod block starts with a @@ -189,7 +189,7 @@ is a verbatim paragraph, because its first line starts with a literal whitespace character (and there's no "=begin"..."=end" region around). The "=begin I" ... "=end I" commands stop -paragraphs that they surround from being parsed as data or verbatim +paragraphs that they surround from being parsed as ordinary or verbatim paragraphs, if I doesn't begin with a colon. This is discussed in detail in the section L=end" Regions>. @@ -337,8 +337,8 @@ paragraph. This command, which should occur early in the document (at least before any non-US-ASCII data!), declares that this document is encoded in the encoding I, which must be -an encoding name that L recognizes. (Encoding's list -of supported encodings, in L, is useful here.) +an encoding name that L recognizes. (Encode's list +of supported encodings, in L, is useful here.) If the Pod parser cannot decode the declared encoding, it should emit a warning and may abort parsing the document altogether. @@ -346,8 +346,8 @@ altogether. A document having more than one "=encoding" line should be considered an error. 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 +first one (e.g., if there's a "=encoding utf8" line, and later on +another "=encoding 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). Pod processors that recognize BOMs @@ -724,7 +724,7 @@ period-space-space or period-newline sequences). Pod parsers should not, by default, try to coerce apostrophe (') and quote (") into smart quotes (little 9's, 66's, 99's, etc), nor try to turn backtick (`) into anything else but a single backtick character -(distinct from an openquote character!), nor "--" into anything but +(distinct from an open quote character!), nor "--" into anything but two minus signs. They I do any of those things to text in CE...> formatting codes, and never I to text in verbatim paragraphs. @@ -959,7 +959,7 @@ for idiosyncratic mappings of Unicode-to-I. =item * -It is up to individual Pod formatter to display good judgment when +It is up to individual Pod formatter to display good judgement when confronted with an unrenderable character (which is distinct from an unknown EEthing> sequence that the parser couldn't resolve to anything, renderable or not). It is good practice to map Latin letters @@ -1130,7 +1130,7 @@ is "perlfunc". In "LE/CAVEATS>", the name is undef.) =item Fourth: The section (AKA "item" in older perlpods), or undef if none. E.g., -in L, "DESCRIPTION" is the section. (Note +in "LEGetopt::Std/DESCRIPTIONE", "DESCRIPTION" is the section. (Note that this is not the same as a manpage section like the "5" in "man 5 crontab". "Section Foo" in the Pod sense means the part of the text that's introduced by the heading or item whose text is "Foo".) @@ -1333,7 +1333,7 @@ given CfooE> code. =item * Previous versions of perlpod allowed for a CsectionE> syntax -(as in "CObject AttributesE>"), which was not easily distinguishable +(as in CObject AttributesE>), which was not easily distinguishable from CnameE> syntax. This syntax is no longer in the specification, and has been replaced by the C"section"E> syntax (where the quotes were formerly optional). Pod parsers should tolerate @@ -1541,7 +1541,7 @@ probably want to format it like so: Ut Enim -But (for the forseeable future), Pod does not provide any way for Pod +But (for the foreseeable future), Pod does not provide any way for Pod authors to distinguish which grouping is meant by the above "=item"-cluster structure. So formatters should format it like so: