cpan/podlators/t/data/basic.clr

   1 \e[1mNAME\e[0m
   2     basic.pod - Test of various basic POD features in translators.
   3
   4 \e[1mHEADINGS\e[0m
   5     Try a few different levels of headings, with embedded formatting codes
   6     and other interesting bits.
   7
   8 \e[1mThis "is" a "level 1" heading\e[0m
   9   \e[1m``Level'' "2 \e[33mheading\e[0m\e[0m
  10    Level 3 \e[1mheading \e[33mwith "weird \e[36mstuff "" (double quote)\e[0m"\e[0m\e[0m
  11    Level "4 "heading"
  12     Now try again with \e[1mintermixed\e[0m \e[36mtext\e[0m.
  13
  14 \e[1mThis "is" a "level 1" heading\e[0m
  15     Text.
  16
  17   \e[1m``Level'' 2 \e[33mheading\e[0m\e[0m
  18     Text.
  19
  20    Level 3 \e[1mheading \e[33mwith "weird \e[36mstuff\e[0m"\e[0m\e[0m
  21     Text.
  22
  23    Level "4 "heading"
  24     Text.
  25
  26 \e[1mLINKS\e[0m
  27     These are all taken from the Pod::Parser tests.
  28
  29     Try out \e[33mLOTS\e[0m of different ways of specifying references:
  30
  31     Reference the "section" in manpage
  32
  33     Reference the "section" in "manpage"
  34
  35     Reference the "section" in manpage
  36
  37     Now try it using the new "|" stuff ...
  38
  39     Reference the thistext|
  40
  41     Reference the thistext |
  42
  43     Reference the thistext|
  44
  45     Reference the thistext |
  46
  47     Reference the thistext|
  48
  49     Reference the thistext|
  50
  51     And then throw in a few new ones of my own.
  52
  53     foo
  54
  55     foo
  56
  57     "bar" in foo
  58
  59     "baz boo" in foo
  60
  61     "bar"
  62
  63     "baz boo"
  64
  65     "baz boo"
  66
  67     "baz boo" in foo bar
  68
  69     "boo var baz"
  70
  71     "bar baz"
  72
  73     "boo", "bar", and "baz"
  74
  75     foobar
  76
  77     Testing \e[33mitalics\e[0m
  78
  79     "\e[33mItalic\e[0m text" in foo
  80
  81     "Section "with" \e[33m\e[1mother\e[0m markup\e[0m" in foo|bar
  82
  83 \e[1mOVER AND ITEMS\e[0m
  84     Taken from Pod::Parser tests, this is a test to ensure that multiline
  85     =item paragraphs get indented appropriately.
  86
  87     This is a test.
  88
  89     There should be whitespace now before this line.
  90
  91     Taken from Pod::Parser tests, this is a test to ensure the nested =item
  92     paragraphs get indented appropriately.
  93
  94     1 First section.
  95
  96       a this is item a
  97
  98       b this is item b
  99
 100     2 Second section.
 101
 102       a this is item a
 103
 104       b this is item b
 105
 106       c
 107       d This is item c & d.
 108
 109     Now some additional weirdness of our own. Make sure that multiple tags
 110     for one paragraph are properly compacted.
 111
 112     "foo"
 113     \e[1mbar\e[0m
 114     "baz"
 115         There shouldn't be any spaces between any of these item tags; this
 116         idiom is used in perlfunc.
 117
 118     Some longer item text
 119         Just to make sure that we test paragraphs where the item text
 120         doesn't fit in the margin of the paragraph (and make sure that this
 121         paragraph fills a few lines).
 122
 123         Let's also make it multiple paragraphs to be sure that works.
 124
 125     Test use of =over without =item as a block "quote" or block paragraph.
 126
 127         This should be indented four spaces but otherwise formatted the same
 128         as any other regular text paragraph. Make sure it's long enough to
 129         see the results of the formatting.....
 130
 131     Now try the same thing nested, and make sure that the indentation is
 132     reset back properly.
 133
 134             This paragraph should be doubly indented.
 135
 136         This paragraph should only be singly indented.
 137
 138         *   This is an item in the middle of a block-quote, which should be
 139             allowed.
 140
 141         *   We're also testing tagless item commands.
 142
 143         Should be back to the single level of indentation.
 144
 145     Should be back to regular indentation.
 146
 147     Now also check the transformation of * into real bullets for man pages.
 148
 149     *   An item. We're also testing using =over without a number, and making
 150         sure that item text wraps properly.
 151
 152     *   Another item.
 153
 154     and now test the numbering of item blocks.
 155
 156     1.  First item.
 157
 158     2.  Second item.
 159
 160 \e[1mFORMATTING CODES\e[0m
 161     Another test taken from Pod::Parser.
 162
 163     This is a test to see if I can do not only $self and method(), but also
 164     "$self->method()" and "$self->{FIELDNAME}" and "$Foo <=> $Bar" without
 165     resorting to escape sequences. If I want to refer to the right-shift
 166     operator I can do something like "$x >> 3" or even "$y >> 5".
 167
 168     Now for the grand finale of "$self->method()->{FIELDNAME} = {FOO=>BAR}".
 169     And I also want to make sure that newlines work like this
 170     "$self->{FOOBAR} >> 3 and [$b => $a]->[$a <=> $b]"
 171
 172     Of course I should still be able to do all this \e[33mwith\e[0m escape sequences
 173     too: "$self->method()" and "$self->{FIELDNAME}" and "{FOO=>BAR}".
 174
 175     Don't forget "$self->method()->{FIELDNAME} = {FOO=>BAR}".
 176
 177     And make sure that 0 works too!
 178
 179     Now, if I use << or >> as my delimiters, then I have to use whitespace.
 180     So things like "<$self-"method()>> and "<$self-"{FIELDNAME}>> won't end
 181     up doing what you might expect since the first > will still terminate
 182     the first < seen.
 183
 184     Lets make sure these work for empty ones too, like "" and ">>" (just to
 185     be obnoxious)
 186
 187     The statement: "This is dog kind's \e[33mfinest\e[0m hour!" is a parody of a
 188     quotation from Winston Churchill.
 189
 190     The following tests are added to those:
 191
 192     Make sure that a few other odd \e[33mthings\e[0m still work. This should be a
 193     vertical bar: |. Here's a test of a few more special escapes that have
 194     to be supported:
 195
 196     &  An ampersand.
 197
 198     '  An apostrophe.
 199
 200     <  A less-than sign.
 201
 202     >  A greater-than sign.
 203
 204     "  A double quotation mark.
 205
 206     /  A forward slash.
 207
 208     Try to get this bit of text over towards the edge so
 209     |that all of this text inside S<> won't| be wrapped. Also test the
 210     |same thing with non-breaking spaces.|
 211
 212     There is a soft hyphen in hyphen at hy-phen.
 213
 214     This is a test of an index entry.
 215
 216 \e[1mVERBATIM\e[0m
 217     Throw in a few verbatim paragraphs.
 218
 219         use Term::ANSIColor;
 220         print color 'bold blue';
 221         print "This text is bold blue.\n";
 222         print color 'reset';
 223         print "This text is normal.\n";
 224         print colored ("Yellow on magenta.\n", 'yellow on_magenta');
 225         print "This text is normal.\n";
 226         print colored ['yellow on_magenta'], "Yellow on magenta.\n";
 227
 228         use Term::ANSIColor qw(uncolor);
 229         print uncolor '01;31', "\n";
 230
 231     But this isn't verbatim (make sure it wraps properly), and the next
 232     paragraph is again:
 233
 234         use Term::ANSIColor qw(:constants);
 235         print BOLD, BLUE, "This text is in bold blue.\n", RESET;
 236
 237         use Term::ANSIColor qw(:constants); $Term::ANSIColor::AUTORESET = 1; print BOLD BLUE "This text is in bold blue.\n"; print "This text is normal.\n";
 238
 239     (Ugh, that's obnoxiously long.) Try different spacing:
 240
 241             Starting with a tab.
 242     Not
 243     starting
 244     with
 245     a
 246     tab.  But this should still be verbatim.
 247      As should this.
 248
 249     This isn't.
 250
 251      This is.  And this:    is an internal tab.  It should be:
 252                         |--| <= lined up with that.
 253
 254     (Tricky, but tabs should be expanded before the translator starts in on
 255     the text since otherwise text with mixed tabs and spaces will get messed
 256     up.)
 257
 258         And now we test verbatim paragraphs right before a heading.  Older
 259         versions of Pod::Man generated two spaces between paragraphs like this
 260         and the heading.  (In order to properly test this, one may have to
 261         visually inspect the nroff output when run on the generated *roff
 262         text, unfortunately.)
 263
 264 \e[1mCONCLUSION\e[0m
 265     That's all, folks!
 266
 267 \e[1mCOPYRIGHT AND LICENSE\e[0m
 268     Copyright 2001, 2004, 2016, 2018 Russ Allbery <rra@cpan.org>
 269
 270     Copying and distribution of this file, with or without modification, are
 271     permitted in any medium without royalty provided the copyright notice
 272     and this notice are preserved. This file is offered as-is, without any
 273     warranty.
 274
 275     SPDX-License-Identifier: FSFAP
 276