Projekt

Allgemein

Profil

« Zurück | Weiter » 

Revision c574ecd3

Von Sven Schöling vor fast 14 Jahren hinzugefügt

  • ID c574ecd33acd23af72ffbd2982bbebd22c048792
  • Vorgänger cbd1249e
  • Nachfolger 5e7090a6

Auf Romans Anregen - Ein simples POD basiertes Hilfesystem

So funktionierts:
- 1. Hilfe in eine pod Datei schreiben
- 2. Pod Datei nach doc/online/<lang>/<tag>.html legen,
wobei <lang> der countrycode der locale ist,
und <tag> ein /[a-zA-Z0-9_]+/ Identifier ist.
- 3. HTML erzeugen mit:

scripts/make_docs.pl

- 4. Im Template einen Hilfelink einbinden mit:

[% L.online_help_tag('tag') %]

Unterschiede anzeigen:

.gitignore
4 4
/users/templates-cache/
5 5
/users/pid/
6 6
/config/lx_office.conf
7
/doc/online/*/*.html
8
pod2html*
SL/Template/Plugin/L.pm
396 396
  return $code;
397 397
}
398 398

  
399
sub online_help_tag {
400
  my ($self, $tag, @slurp) = @_;
401
  my %params               = _hashify(@slurp);
402
  my $cc                   = $::myconfig{countrycode};
403
  my $file                 = "doc/online/$cc/$tag.html";
404
  my $text                 = $params{text} || $::locale->text('Help');
405

  
406
  die 'malformed help tag' unless $tag =~ /^[a-zA-Z0-9_]+$/;
407
  return unless -f $file;
408
  return $self->html_tag('a', $text, href => $file, target => '_blank');
409
}
410

  
399 411
sub dump {
400 412
  my $self = shift;
401 413
  require Data::Dumper;
css/lx-office-erp.css
134 134
/*
135 135
    Überschriftsbalken
136 136
*/
137
.listtop {
137
.listtop, h1 {
138 138
    background-color: rgb(236,233,216);
139 139
    text-align:left;
140 140
    padding:5px;
scripts/make_docs.pl
1
#!/usr/bin/perl
2

  
3
use strict;
4

  
5
use Pod::Html;
6
use File::Find;
7

  
8
my $doc_path     = "doc/online";
9
#my $pod2html_bin = `which pod2html` or die 'cannot find pod2html on your system';
10

  
11
find({no_chdir => 1, wanted => sub {
12
  next unless -f;
13
  next unless /\.pod$/;
14
  print "processing $_,$/";
15
  my $html_file = $_;
16
  $html_file =~ s/\.pod$/.html/;
17
  pod2html(
18
#    $pod2html_bin,
19
    '--noindex',
20
    '--css=../../../css/lx-office-erp.css',
21
    "--infile=$_",
22
    "--outfile=$html_file",
23
  );
24
}}, $doc_path);
25

  
26
1;

Auch abrufbar als: Unified diff