-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.txt2html
1393 lines (992 loc) · 44 KB
/
README.txt2html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
NAME
HTML::TextToHTML - convert plain text file to HTML
VERSION
version 3.0
SYNOPSIS
From the command line:
txt2html I<arguments>
From Scripts:
use HTML::TextToHTML;
# create a new object
my $conv = new HTML::TextToHTML();
# convert a file
$conv->txt2html(infile=>[$text_file],
outfile=>$html_file,
title=>"Wonderful Things",
mail=>1,
]);
# reset arguments
$conv->args(infile=>[], mail=>0);
# convert a string
$newstring = $conv->process_chunk($mystring)
DESCRIPTION
HTML::TextToHTML converts plain text files to HTML. The txt2html script
uses this module to do the same from the command-line.
It supports headings, tables, lists, simple character markup, and
hyperlinking, and is highly customizable. It recognizes some of the
apparent structure of the source document (mostly whitespace and
typographic layout), and attempts to mark that structure explicitly
using HTML. The purpose for this tool is to provide an easier way of
converting existing text documents to HTML format, giving something
nicer than just whapping the text into a big PRE block.
History
The original txt2html script was written by Seth Golub (see
http://www.aigeek.com/txt2html/), and converted to a perl module by
Kathryn Andersen (see http://www.katspace.com/tools/text_to_html/) and
made into a sourceforge project by Sun Tong (see
http://sourceforge.net/projects/txt2html/). Earlier versions of the
HTML::TextToHTML module called the included script texthyper so as not
to clash with the original txt2html script, but now the projects have
all been merged. UPDATING: currently, the project is available on GitHub
at https://github.com/resurrecting-open-source-projects/txt2html
OPTIONS
All arguments can be set when the object is created, and further options
can be set when calling the actual txt2html method. Arguments to methods
can take a hash of arguments.
Note that all option-names must match exactly -- no abbreviations are
allowed. The argument-keys are expected to have values matching those
required for that argument -- whether that be a boolean, a string, a
reference to an array or a reference to a hash. These will replace any
value for that argument that might have been there before.
append_file
append_file=>I<filename>
If you want something appended by default, put the filename here.
The appended text will not be processed at all, so make sure it's
plain text or correct HTML. i.e. do not have things like: Mary
Andersen <[email protected]> but instead, have: Mary Andersen
<[email protected]>
(default: nothing)
append_head
append_head=>I<filename>
If you want something appended to the head by default, put the
filename here. The appended text will not be processed at all, so
make sure it's plain text or correct HTML. i.e. do not have things
like: Mary Andersen <[email protected]> but instead, have: Mary
Andersen <[email protected]>
(default: nothing)
body_deco
body_deco=>I<string>
Body decoration string: a string to be added to the BODY tag so that
one can set attributes to the BODY (such as class, style, bgcolor
etc) For example, "class='withimage'".
bold_delimiter
bold_delimiter=>I<string>
This defines what character (or string) is taken to be the delimiter
of text which is to be interpreted as bold (that is, to be given a
STRONG tag). If this is empty, then no bolding of text will be done.
(default: #)
bullets
bullets=>I<string>
This defines what single characters are taken to be "bullet"
characters for unordered lists. Note that because this is used as a
character class, if you use '-' it must come first.
(default:-=o*\267)
bullets_ordered
bullets_ordered=>I<string>
This defines what single characters are taken to be "bullet"
placeholder characters for ordered lists. Ordered lists are normally
marked by a number or letter followed by '.' or ')' or ']' or ':'.
If an ordered bullet is used, then it simply indicates that this is
an ordered list, without giving explicit numbers.
Note that because this is used as a character class, if you use '-'
it must come first. (default:nothing)
caps_tag
caps_tag=>I<tag>
Tag to put around all-caps lines (default: STRONG) If an empty tag
is given, then no tag will be put around all-caps lines.
custom_heading_regexp
custom_heading_regexp=>\@custom_headings
Add patterns for headings. Header levels are assigned by regexp in
the order seen in the input text. When a line matches a custom
header regexp, it is tagged as a header. If it's the first time that
particular regexp has matched, the next available header level is
associated with it and applied to the line. Any later matches of
that regexp will use the same header level. Therefore, if you want
to match numbered header lines, you could use something like this:
my @custom_headings = ('^ *\d+\. \w+',
'^ *\d+\.\d+\. \w+',
'^ *\d+\.\d+\.\d+\. \w+');
...
custom_heading_regexp=>\@custom_headings,
...
Then lines like
" 1. Examples "
" 1.1. Things"
and " 4.2.5. Cold Fusion"
Would be marked as H1, H2, and H3 (assuming they were found in that
order, and that no other header styles were encountered). If you
prefer that the first one specified always be H1, the second always
be H2, the third H3, etc, then use the "explicit_headings" option.
This expects a reference to an array of strings.
(default: none)
default_link_dict
default_link_dict=>I<filename>
The name of the default "user" link dictionary. (default:
"$ENV{'HOME'}/.txt2html.dict" -- this is the same as for the
txt2html script. If there is no $ENV{HOME} then it is just
'.txt2html.dict')
demoronize
demoronize=>1
Convert Microsoft-generated character codes that are non-ISO codes
into something more reasonable. (default:true)
doctype
doctype=>I<doctype>
This gets put in the DOCTYPE field at the top of the document,
unless it's empty.
Default : '-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd'
If xhtml is true, the contents of this is ignored, unless it's
empty, in which case no DOCTYPE declaration is output.
eight_bit_clean
eight_bit_clean=>1
If false, convert Latin-1 characters to HTML entities. If true, this
conversion is disabled; also "demoronize" is set to false, since
this also changes 8-bit characters. (default: false)
escape_HTML_chars
escape_HTML_chars=>1
turn & < > into & > < (default: true)
explicit_headings
explicit_headings=>1
Don't try to find any headings except the ones specified in the
--custom_heading_regexp option. Also, the custom headings will not
be assigned levels in the order they are encountered in the
document, but in the order they are specified on the
custom_heading_regexp option. (default: false)
extract
extract=>1
Extract Mode; don't put HTML headers or footers on the result, just
the plain HTML (thus making the result suitable for inserting into
another document (or as part of the output of a CGI script).
(default: false)
hrule_min
hrule_min=>I<n>
Min number of ---s for an HRule. (default: 4)
indent_width
indent_width=>I<n>
Indents this many spaces for each level of a list. (default: 2)
indent_par_break
indent_par_break=>1
Treat paragraphs marked solely by indents as breaks with indents.
That is, instead of taking a three-space indent as a new paragraph,
put in a <BR> and three non-breaking spaces instead. (see also
--preserve_indent) (default: false)
infile
infile=>\@my_files
infile=>['chapter1.txt', 'chapter2.txt']
The name of the input file(s). This expects a reference to an array
of filenames.
The special filename '-' designates STDIN.
See also "inhandle" and "instring".
(default:-)
inhandle
inhandle=>\@my_handles
inhandle=>[\*MYINHANDLE, \*STDIN]
An array of input filehandles; use this instead of "infile" or
"instring" to use a filehandle or filehandles as input.
instring
instring=>\@my_strings
instring=>[$string1, $string2]
An array of input strings; use this instead of "infile" or
"inhandle" to use a string or strings as input.
italic_delimiter
italic_delimiter=>I<string>
This defines what character (or string) is taken to be the delimiter
of text which is to be interpreted as italic (that is, to be given a
EM tag). If this is empty, no italicising of text will be done.
(default: *)
underline_delimiter
underline_delimiter=>I<string>
This defines what character (or string) is taken to be the delimiter
of text which is to be interpreted as underlined (that is, to be
given a U tag). If this is empty, no underlining of text will be
done. (default: _)
links_dictionaries
links_dictionaries=>\@my_link_dicts
links_dictionaries=>['url_links.dict', 'format_links.dict']
File(s) to use as a link-dictionary. There can be more than one of
these. These are in addition to the Global Link Dictionary and the
User Link Dictionary. This expects a reference to an array of
filenames.
link_only
link_only=>1
Do no escaping or marking up at all, except for processing the links
dictionary file and applying it. This is useful if you want to use
the linking feature on an HTML document. If the HTML is a complete
document (includes HTML,HEAD,BODY tags, etc) then you'll probably
want to use the --extract option also. (default: false)
lower_case_tags
lower_case_tags=>1
Force all tags to be in lower-case.
mailmode
mailmode=>1
Deal with mail headers & quoted text. The mail header paragraph is
given the class 'mail_header', and mail-quoted text is given the
class 'quote_mail'. (default: false)
make_anchors
make_anchors=>0
Should we try to make anchors in headings? (default: true)
make_links
make_links=>0
Should we try to build links? If this is false, then the links
dictionaries are not consulted and only structural text-to-HTML
conversion is done. (default: true)
make_tables
make_tables=>1
Should we try to build tables? If true, spots tables and marks them
up appropriately. See "Input File Format" for information on how
tables should be formatted.
This overrides the detection of lists; if something looks like a
table, it is taken as a table, and list-checking is not done for
that paragraph.
(default: false)
min_caps_length
min_caps_length=>I<n>
min sequential CAPS for an all-caps line (default: 3)
outfile
outfile=>I<filename>
The name of the output file. If it is "-" then the output goes to
Standard Output. (default: - )
outhandle
The output filehandle; if this is given then the output goes to this
filehandle instead of to the file given in "outfile".
par_indent
par_indent=>I<n>
Minimum number of spaces indented in first lines of paragraphs. Only
used when there's no blank line preceding the new paragraph.
(default: 2)
preformat_trigger_lines
preformat_trigger_lines=>I<n>
How many lines of preformatted-looking text are needed to switch to
<PRE> <= 0 : Preformat entire document 1 : one line triggers >= 2 :
two lines trigger
(default: 2)
endpreformat_trigger_lines
endpreformat_trigger_lines=>I<n>
How many lines of unpreformatted-looking text are needed to switch
from <PRE> <= 0 : Never preformat within document 1 : one line
triggers >= 2 : two lines trigger (default: 2)
NOTE for preformat_trigger_lines and endpreformat_trigger_lines: A
zero takes precedence. If one is zero, the other is ignored. If both
are zero, entire document is preformatted.
preformat_start_marker
preformat_start_marker=>I<regexp>
What flags the start of a preformatted section if
--use_preformat_marker is true.
(default: "^(:?(:?<)|<)PRE(:?(:?>)|>)\$")
preformat_end_marker
preformat_end_marker=>I<regexp>
What flags the end of a preformatted section if
--use_preformat_marker is true.
(default: "^(:?(:?<)|<)/PRE(:?(:?>)|>)\$")
preformat_whitespace_min
preformat_whitespace_min=>I<n>
Minimum number of consecutive whitespace characters to trigger
normal preformatting. NOTE: Tabs are expanded to spaces before this
check is made. That means if tab_width is 8 and this is 5, then one
tab may be expanded to 8 spaces, which is enough to trigger
preformatting. (default: 5)
prepend_file
prepend_file=>I<filename>
If you want something prepended to the processed body text, put the
filename here. The prepended text will not be processed at all, so
make sure it's plain text or correct HTML.
(default: nothing)
preserve_indent
preserve_indent=>1
Preserve the first-line indentation of paragraphs marked with
indents by replacing the spaces of the first line with non-breaking
spaces. (default: false)
short_line_length
short_line_length=>I<n>
Lines this short (or shorter) must be intentionally broken and are
kept that short. (default: 40)
style_url
style_url=>I<url>
This gives the URL of a stylesheet; a LINK tag will be added to the
output.
tab_width
tab_width=>I<n>
How many spaces equal a tab? (default: 8)
table_type
table_type=>{ ALIGN=>0, PGSQL=>0, BORDER=>1, DELIM=>0 }
This determines which types of tables will be recognised when
"make_tables" is true. The possible types are ALIGN, PGSQL, BORDER
and DELIM. (default: all types are true)
title
title=>I<title>
You can specify a title. Otherwise it will use a blank one.
(default: nothing)
titlefirst
titlefirst=>1
Use the first non-blank line as the title. (See also "title")
underline_length_tolerance
underline_length_tolerance=>I<n>
How much longer or shorter can underlines be and still be
underlines? (default: 1)
underline_offset_tolerance
underline_offset_tolerance=>I<n>
How far offset can underlines be and still be underlines? (default:
1)
unhyphenation
unhyphenation=>0
Enables unhyphenation of text. (default: true)
use_mosaic_header
use_mosaic_header=>1
Use this option if you want to force the heading styles to match
what Mosaic outputs. (Underlined with "***"s is H1, with "==="s is
H2, with "+++" is H3, with "---" is H4, with "~~~" is H5 and with
"..." is H6) This was the behavior of txt2html up to version 1.10.
(default: false)
use_preformat_marker
use_preformat_marker=>1
Turn on preformatting when encountering "<PRE>" on a line by itself,
and turn it off when there's a line containing only "</PRE>". When
such preformatted text is detected, the PRE tag will be given the
class 'quote_explicit'. (default: off)
xhtml
xhtml=>1
Try to make the output conform to the XHTML standard, including
closing all open tags and marking empty tags correctly. This turns
on --lower_case_tags and overrides the --doctype option. Note that
if you add a header or a footer file, it is up to you to make it
conform; the header/footer isn't touched by this. Likewise, if you
make link-dictionary entries that break XHTML, then this won't fix
them, except to the degree of putting all tags into lower-case.
(default: true)
DEBUGGING
There are global variables for setting types and levels of debugging.
These should only be used by developers.
$HTML::TextToHTML::Debug
$HTML::TextToHTML::Debug = 1;
Enable copious debugging output. (default: false)
$HTML::TextToHTML::DictDebug
$HTML::TextToHTML::DictDebug = I<n>;
Debug mode for link dictionaries. Bitwise-Or what you want to see:
1: The parsing of the dictionary
2: The code that will make the links
4: When each rule matches something
8: When each tag is created
(default: 0)
METHODS
new
$conv = new HTML::TextToHTML()
$conv = new HTML::TextToHTML(titlefirst=>1,
...
);
Create a new object with new. If arguments are given, these arguments
will be used in invocations of other methods.
See "OPTIONS" for the possible values of the arguments.
args
$conv->args(short_line_length=>60,
titlefirst=>1,
....
);
Updates the current arguments/options of the HTML::TextToHTML object.
Takes hash of arguments, which will be used in invocations of other
methods. See "OPTIONS" for the possible values of the arguments.
process_chunk
$newstring = $conv->process_chunk($mystring);
Convert a string to a HTML fragment. This assumes that this string is at
the least, a single paragraph, but it can contain more than that. This
returns the processed string. If you want to pass arguments to alter the
behaviour of this conversion, you need to do that earlier, either when
you create the object, or with the "args" method.
$newstring = $conv->process_chunk($mystring,
close_tags=>0);
If there are open tags (such as lists) in the input string,
process_chunk will automatically close them, unless you specify not to,
with the close_tags option.
$newstring = $conv->process_chunk($mystring,
is_fragment=>1);
If you want this string to be treated as a fragment, and not assumed to
be a paragraph, set is_fragment to true. If there is more than one
paragraph in the string (ie it contains blank lines) then this option
will be ignored.
process_para
$newstring = $conv->process_para($mystring);
Convert a string to a HTML fragment. This assumes that this string is at
the most a single paragraph, with no blank lines in it. If you don't
know whether your string will contain blank lines or not, use the
"process_chunk" method instead.
This returns the processed string. If you want to pass arguments to
alter the behaviour of this conversion, you need to do that earlier,
either when you create the object, or with the "args" method.
$newstring = $conv->process_para($mystring,
close_tags=>0);
If there are open tags (such as lists) in the input string, process_para
will automatically close them, unless you specify not to, with the
close_tags option.
$newstring = $conv->process_para($mystring,
is_fragment=>1);
If you want this string to be treated as a fragment, and not assumed to
be a paragraph, set is_fragment to true.
txt2html
$conv->txt2html(%args);
Convert a text file to HTML. Takes a hash of arguments. See "OPTIONS"
for the possible values of the arguments. Arguments which have already
been set with new or args will remain as they are, unless they are
overridden.
PRIVATE METHODS
These are methods used internally, only of interest to developers.
init_our_data
$self->init_our_data();
Initializes the internal object data.
deal_with_options
$self->deal_with_options();
do extra processing related to particular options
escape
$newtext = escape($text);
Escape & < and >
demoronize_char
$newtext = demoronize_char($text);
Convert Microsoft character entities into characters.
Added by Alan Jackson, alan at ajackson dot org, and based on the
demoronize script by John Walker, http://www.fourmilab.ch/
demoronize_code
$newtext = demoronize_code($text);
convert Microsoft character entities into HTML code
get_tag
$tag = $self->get_tag($in_tag);
$tag = $self->get_tag($in_tag, tag_type=>TAG_START, inside_tag=>'');
output the tag wanted (add the <> and the / if necessary) - output in
lower or upper case - do tag-related processing options:
tag_type=>TAG_START | tag_type=>TAG_END | tag_type=>TAG_EMPTY (default
start) inside_tag=>string (default empty)
close_tag
$tag = $self->close_tag($in_tag);
close the open tag
hrule
$self->hrule(para_lines_ref=>$para_lines,
para_action_ref=>$para_action,
ind=>0);
Deal with horizontal rules.
shortline
$self->shortline(line_ref=>$line_ref,
line_action_ref=>$line_action_ref,
prev_ref=>$prev_ref,
prev_action_ref=>$prev_action_ref,
prev_line_len=>$prev_line_len);
Deal with short lines.
is_mailheader
if ($self->is_mailheader(rows_ref=>$rows_ref))
{
...
}
Is this a mailheader line?
mailheader
$self->mailheader(rows_ref=>$rows_ref);
Deal with a mailheader.
mailquote
$self->mailquote(line_ref=>$line_ref,
line_action_ref=>$line_action_ref,
prev_ref=>$prev_ref,
prev_action_ref=>$prev_action_ref,
next_ref=>$next_ref);
Deal with quoted mail.
subtract_modes
$newvector = subtract_modes($vector, $mask);
Subtracts modes listed in $mask from $vector.
paragraph
$self->paragraph(line_ref=>$line_ref,
line_action_ref=>$line_action_ref,
prev_ref=>$prev_ref,
prev_action_ref=>$prev_action_ref,
line_indent=>$line_indent,
prev_indent=>$prev_indent,
is_fragment=>$is_fragment,
ind=>$ind);
Detect paragraph indentation.
listprefix
($prefix, $number, $rawprefix, $term) = $self->listprefix($line);
Detect and parse a list item.
startlist
$self->startlist(prefix=>$prefix,
number=>0,
rawprefix=>$rawprefix,
term=>$term,
para_lines_ref=>$para_lines_ref,
para_action_ref=>$para_action_ref,
ind=>0,
prev_ref=>$prev_ref,
total_prefix=>$total_prefix);
Start a list.
endlist
$self->endlist(num_lists=>0,
prev_ref=>$prev_ref,
line_action_ref=>$line_action_ref);
End N lists
continuelist
$self->continuelist(para_lines_ref=>$para_lines_ref,
para_action_ref=>$para_action_ref,
ind=>0,
term=>$term);
Continue a list.
liststuff
$self->liststuff(para_lines_ref=>$para_lines_ref,
para_action_ref=>$para_action_ref,
para_line_indent_ref=>$para_line_indent_ref,
ind=>0,
prev_ref=>$prev_ref);
Process a list (higher-level method).
get_table_type
$table_type = $self->get_table_type(rows_ref=>$rows_ref,
para_len=>0);
Figure out the table type of this table, if any
is_aligned_table
if ($self->is_aligned_table(rows_ref=>$rows_ref, para_len=>0))
{
...
}
Check if the given paragraph-array is an aligned table
is_pgsql_table
if ($self->is_pgsql_table(rows_ref=>$rows_ref, para_len=>0))
{
...
}
Check if the given paragraph-array is a Postgresql table (the ascii
format produced by Postgresql)
A PGSQL table can start with an optional table-caption,
then it has a row of column headings separated by |
then it has a row of ------+-----
then it has one or more rows of column values separated by |
then it has a row-count (N rows)
is_border_table
if ($self->is_border_table(rows_ref=>$rows_ref, para_len=>0))
{
...
}
Check if the given paragraph-array is a Border table.
A BORDER table can start with an optional table-caption,
then it has a row of +------+-----+
then it has a row of column headings separated by |
then it has a row of +------+-----+
then it has one or more rows of column values separated by |
then it has a row of +------+-----+
is_delim_table
if ($self->is_delim_table(rows_ref=>$rows_ref, para_len=>0))
{
...
}
Check if the given paragraph-array is a Delimited table.
A DELIM table can start with an optional table-caption, then it has at
least two rows which start and end and are punctuated by a
non-alphanumeric delimiter.
| val1 | val2 |
| val3 | val4 |
tablestuff
$self->tablestuff(table_type=>0,
rows_ref=>$rows_ref,
para_len=>0);
Process a table.
make_aligned_table
$self->make_aligned_table(rows_ref=>$rows_ref,
para_len=>0);
Make an Aligned table.
make_pgsql_table
$self->make_pgsql_table(rows_ref=>$rows_ref,
para_len=>0);
Make a PGSQL table.
make_border_table
$self->make_border_table(rows_ref=>$rows_ref,
para_len=>0);
Make a BORDER table.
make_delim_table
$self->make_delim_table(rows_ref=>$rows_ref,
para_len=>0);
Make a Delimited table.
is_preformatted
if ($self->is_preformatted($line))
{
...
}
Returns true if the passed string is considered to be preformatted.
split_end_explicit_preformat
$front = $self->split_end_explicit_preformat(para_ref=>$para_ref);
Modifies the given string, and returns the front preformatted part.
endpreformat
$self->endpreformat(para_lines_ref=>$para_lines_ref,
para_action_ref=>$para_action_ref,
ind=>0,
prev_ref=>$prev_ref);
End a preformatted section.
preformat
$self->preformat(mode_ref=>$mode_ref,
line_ref=>$line_ref,
line_action_ref=>$line_action_ref,
prev_ref=>$prev_ref,
next_ref=>$next_ref,
prev_action_ref);
Detect and process a preformatted section.
make_new_anchor
$anchor = $self->make_new_anchor($heading_level);
Make a new anchor.
anchor_mail
$self->anchor_mail($line_ref);
Make an anchor for a mail section.
anchor_heading
$self->anchor_heading($heading_level, $line_ref);
Make an anchor for a heading.
heading_level
$self->heading_level($style);
Add a new heading style if this is a new heading style.
is_ul_list_line
if ($self->is_ul_list_line($line))
{
...
}
Tests if this line starts a UL list item.
is_heading
if ($self->is_heading(line_ref=>$line_ref, next_ref=>$next_ref))
{
...
}
Tests if this line is a heading. Needs to take account of the next line,
because a standard heading is defined by "underlining" the text of the
heading.
heading
$self->heading(line_ref=>$line_ref,
next_ref=>$next_ref);
Make a heading. Assumes is_heading is true.
is_custom_heading
if ($self->is_custom_heading($line))
{
...
}
Check if the given line matches a custom heading.
custom_heading
$self->custom_heading(line_ref=>$line_ref);
Make a custom heading. Assumes is_custom_heading is true.
unhyphenate_para
$self->unhyphenate_para($para_ref);
Join up hyphenated words that are split across lines.
tagline
$self->tagline($tag, $line_ref);
Put the given tag around the given line.
iscaps
if ($self->iscaps($line))
{
...
}
Check if a line is all capitals.
caps
$self->caps(line_ref=>$line_ref,
line_action_ref=>$line_action_ref);
Detect and deal with an all-caps line.
do_delim
$self->do_delim(line_ref=>$line_ref,
line_action_ref=>$line_action_ref,
delim=>'*',
tag=>'STRONG');
Deal with a line which has words delimited by the given delimiter; this
is used to deal with italics, bold and underline formatting.
glob2regexp
$regexp = glob2regexp($glob);
Convert very simple globs to regexps
add_regexp_to_links_table
$self->add_regexp_to_links_table(label=>$label,
pattern=>$pattern,
url=>$url,
switches=>$switches);
Add the given regexp "link definition" to the links table.
add_literal_to_links_table
$self->add_literal_to_links_table(label=>$label,
pattern=>$pattern,
url=>$url,
switches=>$switches);
Add the given literal "link definition" to the links table.
add_glob_to_links_table
$self->add_glob_to_links_table(label=>$label,
pattern=>$pattern,
url=>$url,
switches=>$switches);
Add the given glob "link definition" to the links table.
parse_dict
$self->parse_dict($dictfile, $dict);
Parse the dictionary file. (see also load_dictionary_links, for things
that were stripped)
setup_dict_checking
$self->setup_dict_checking();
Set up the dictionary checking.
in_link_context
if ($self->in_link_context($match, $before))
{
...
}