Thread Links im POD (11 answers)
Opened by GUIfreund at 2012-09-08 12:36

topeg
 2012-09-11 01:06
#161739 #161739
User since
2006-07-10
2611 articles
BenutzerIn

user image
Ich hatte mal ein ähnliches Problem. Ich hatte mehrere Module die zusammen gehörten. Dazu wollte ich eine komplette HTML-Doku. Leider Verweisen L<PACKAGE::NAME> immer nach cpan, was natürlich nicht sinnig ist, wenn man eine lokale Doku haben will. Hier meine Lösung:

more (68.6kb):
Code (perl): (dl )
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
#!/usr/bin/perl
use strict;
use warnings;
use File::Spec;
use Getopt::Long;
use POSIX qw(:errno_h);

my $verbose=0;
my $charset='UTF-8';
my $output_base=File::Spec->curdir();
my $input_base=File::Spec->curdir();
my @modules=();
my @env_dirs=();
my @files=();

$charset=$ENV{MM_CHARSET} if($ENV{MM_CHARSET});
$charset=$ENV{HTML_CHARSET} if($ENV{HTML_CHARSET});

GetOptions (
  "charset=s"    => \$charset,
  "outdir|dir=s" => \$output_base,
  "basedir=s"    => \$input_base,
  "env=s"        => \@env_dirs,
  "module=s"     => \@modules,
  "file=s"       => \@files,
  "help"         => sub{ usage(); },
  "verbose"      => \$verbose,
) || usage('Unkown option',0,EINVAL());

@modules=@ARGV if(@ARGV);
unshift(@INC,@env_dirs);
usage('No Modul !',0,EINVAL()) unless(@modules);

$input_base=File::Spec->rel2abs($input_base);
@files=map{ File::Spec->rel2abs($_,$input_base) }@files;

$Pod::Simple::HTML::Content_decl = qq{<meta http-equiv="Content-Type" content="text/html; charset=$charset" >};

########################################################################

for my $path (@files)
{
  unless(convert_file($path))
  { usage(qq(File "$path" not found!),1,ENOENT()); }
}

for my $module (@modules)
{
  my $path=get_filename($module);
  unless(convert_file($path,$module))
  { usage(qq(File for Module "$module" not found!),1,ENOENT()); }
}

########################################################################
# Funktionen
########################################################################

sub convert_file
{
  my $path=shift;
  my $module=shift;
  if($path && -f $path )
  {
    print qq|Read Pod from $path\n| if($verbose);
    my $pod=Pod::Simple::HTML::Local->new();
    my $html='';
    $pod->output_string(\$html);
    $pod->set_module_match_ref(\@modules);
    $pod->set_file_match_ref(\@files);
    $pod->set_source( $path );
    $pod->set_base_dir( $input_base );
    $pod->run;

    if($html)
    {
      print "HTML created \n" if($verbose);
      my $outputname='';
      if($module)
      { $outputname=File::Spec->join($output_base,Pod::Simple::HTML::Local::convert_module_name($module)); }
      else
      { $outputname=File::Spec->join($output_base,Pod::Simple::HTML::Local::convert_file_name($path)); }
      print qq(Write HTML to file "$outputname" \n) if($verbose);
      create_path($outputname) or usage(qq|ERROR create "$outputname" ($!)\n|,1,EACCES());
      open(my $fh, '>', $outputname) or usage(qq|ERROR create "$outputname" ($!)\n|,1,EACCES());
      print $fh $html;
      close($fh);
    }
    else
    { print "NO HTML created\n" if($verbose); }
    return 1;
  }
  return 0;
}

sub usage
{
  my $msg=shift || '';
  my $nohelp=shift || 0;
  my $exit=shift || 0;

  my $out=\*STDOUT;

  if($msg)
  {
    $out=\*STDERR;
    print $out "ERROR: $msg\n";
    $exit=255 unless($exit);
  }

  print $out <<EOH if(!$nohelp);
USAGE:
  $0 [-hv] [-e <path/to/modules>] [-c <charset>] [-d <output/dir>] [-b <working/dir>] [-f <POD-File> [-f <POD-File> ...]] [-m <Module::A>] [<Module::B> [<Module::C> ...] ]

Convert POD to HTML with subpackages as local files
and set links correctly.
 OPTIONS:
  -d | -o | --dir | --outputdir
    Set destination directory for the HTML files.
    Default directory is the current.
  -b --basedir
    Set source directory for the pod files.
    Default directory is the current.
  -c | --charset
    Set the character encoding in HTML document.
    UTF-8 is set as default. If available the enviroment variable
    MM_CHARSET or HTML_CHARSET will be used.
  -m | --module
    Set one or more modules which POD should be converted
  -f | --file
    Set one or more files which POD should be converted
  -e | --env
    Set one or more directories where modules can be found
  -h | --help
    Show this text
  -v | --verbose
    verbose output
EOH

 exit($exit);
}

sub get_filename
{
  my $module=shift;
  my $name=undef;

  if( -f $module)
  { $name=$module; }
  else
  {
    my @dirs=split('::',$module);
    my $path=File::Spec->join(@dirs);
    $path.='.pm';
    for my $base (@INC)
    {
      my $fullpath=File::Spec->join($base,$path);
      if(-f $fullpath)
      {
        $name=$fullpath;
        last;
      }
    }
    unless($name)
    {
      my $fullpath=File::Spec->rel2abs($path);
      $name=$fullpath if(-f $fullpath);
    }
  }
  return $name;
}

sub create_path
{
  my $path=shift;
  return 0 unless($path);

  $path=File::Spec->rel2abs($path);
  return 0 unless($path);

  my ($run,$directories,undef) = File::Spec->splitpath( $path );
  for my $dir (File::Spec->splitdir( $directories ))
  {
    $run=File::Spec->join($run,$dir);
    unless(-d $run)
    {
      return 0 unless(mkdir($run));
    }
  }

  return 1;
}

########################################################################
# Pod::Simple::HTML::Local
########################################################################

package Pod::Simple::HTML::Local;
use base 'Pod::Simple::HTML';
use URI::Escape;
# Links anders verarbeiten
# das mache ich mit dem Überschreiben der passenden Funktion in
# Pod::Simple::HTML

sub set_base_dir
{
  my $self=shift;
  my $path=shift;
  return 0 if(!$path);
  $self->{INPUT_BASE_DIR}=$path;
}

sub set_module_match_ref
{
  my $self=shift;
  my $ref=shift;
  return 0 if(ref($ref) ne 'ARRAY');
  $self->{MODULE_MATCH}=$ref;
  return 1;
}

sub set_file_match_ref
{
  my $self=shift;
  my $ref=shift;
  return 0 if(ref($ref) ne 'ARRAY');
  $self->{FILE_MATCH}=$ref;
  return 1;
}

sub resolve_pod_link_by_table
{
  my ($self,$it,$section)=@_;
  $self->{MODULE_MATCH}=[] unless($self->{MODULE_MATCH} && ref($self->{MODULE_MATCH}) eq "ARRAY");
  $self->{FILE_MATCH}=[] unless($self->{FILE_MATCH} && ref($self->{FILE_MATCH}) eq "ARRAY");

  my $file;

  if(!$it && $section)
  { $file='/'.uri_unescape($section); }
  elsif($it && $section && $it!~/::/)
  { $file=$it.'/'.uri_unescape($section); }
  elsif($it && $it!~/::/)
  { $file=$it; }

  if($file)
  { $file=File::Spec->rel2abs($file,$self->{INPUT_BASE_DIR}); }

  if($file)
  {
    # datei in liste
    if(grep{$_ eq $file}@{$self->{FILE_MATCH}})
    { return convert_file_name($file); }

    # datei mit #pageref
    for my $path (@{$self->{FILE_MATCH}} )
    {
      if($file=~/^\Q$path\E(.*?)$/)
      {
        my $add=$1;
        $add=~s!^[/#]+!!;
        return convert_file_name($path).'#'.$add;
      }
    }

    # Die Datei ist ".pod" und bekannt
    if($file=~m!^(.+?\.pod)((?:[/#].+?)?)$!)
    {
      my ($path,$add)=($1,$2);
      $add=~s!^[/#]+!!;
      if(-f $path)
      {
        push(@{$self->{FILE_MATCH}},$path);
        return convert_file_name($path).($add?'#'.$add:'');
      }
    }
  }

  if($section)
  {$section='#'.$section; }
  else
  { $section=''; }

  # Das Modul ist in der Liste
  if(grep{$_ eq $it}@{$self->{MODULE_MATCH}})
  { return convert_module_name($it).$section; }

  # Das Modul gehört zum selben Paket
  if(grep{$it=~m!^\Q$_!}@{$self->{MODULE_MATCH}})
  {
    push(@{$self->{MODULE_MATCH}},$it);
    return convert_module_name($it).$section;
  }

  return undef;
}

########################################################################

sub convert_module_name
{
  my $module=shift || '';
  $module=~s/::/_/g;
  $module.='.html';
  return $module;
}

sub convert_file_name
{
  my $file=shift || '';
  return $file if($file=~/\.html?$/);
  $file=~s!^.*?([^\\/]+)\.pod$!$1.html!;
  return $file;
}


Dieses Script erzeugt aus POD HTML und verändert Links L<PACKAGE::NAME> L<file.pod> so dass sie auf lokale Dateien zeigen.

EDIT:
Eine neuere Version des Scrips. Das alte kam mit ".pod" Dateien nicht so gut klar. Die neue Version ist da zuverlässiger. Damit das ganze korrekt funktioniert sollte man alle POD-Dateien in einem Verzeichnis haben und dieses mit "--basedir" oder "-b" bekannt machen. Ansonsten gibt es Probleme mit dem Auflösen der Pfade. Das ganze ist nicht ganz einfach, da der Parser in Links alles nach einem "/" als Verweis auf einer Seite interpretiert. Ich habe versucht heraus zu finden, ob es sich bei den Links um Verweise auf Dateien oder Module handelt. Ich weiß nicht ob das immer korrekt funktioniert.
Last edited: 2012-09-11 02:33:33 +0200 (CEST)

View full thread Links im POD