Links im POD (solved) (Allgemeines zu Perl)

[thread]17739[/thread]

Links im POD [solved]

Tags: perl5 HTML pod Link Similar Threads

Readers: 21

Articles: hide open all | hide show old branches

+12 replies
GUIfreund

2012-09-08 12:36

User since
2011-08-08
559 articles
BenutzerIn

Zur besseren Übersichtlichkeit habe ich die Doku zu meinem Programm in 2 Teile zerlegt, myproc_basic.pod und myproc_details.pod. Beide liegen im selben Verzeichnis. Es liegt in der Natur der Sache, dass ich einige Querverweise zwischen beiden Teilen benötige. Wie muss ich diese Links gestalten, damit sie in den aus den PODs erzeugten HTMLs durch Anklicken funktionieren? Schön wäre es, wenn dabei gleich der richtige Abschnitt gezeigt würde.
Gruß
GUIfreund
- +11 replies
- pq
 
 2012-09-09 01:46
 
 User since
 2003-08-04
 12209 articles
 Admin1
 
 wenn ich links zu anderen packages mache, nehme ich einfach L<PACKAGE::NAME>. zu einem anker sprint man mit L<PACKAGE::NAME/anker>.
 mit einfachen dateien ohne packages habe ich das aber noch nie probiert.
 Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live. -- Damian Conway in "Perl Best Practices"
 lesen: Wie frage ich & perlintro brian's Leitfaden für jedes Perl-Problem
 - +10 replies
 - GUIfreund
 
 2012-09-09 15:03
 
 User since
 2011-08-08
 559 articles
 BenutzerIn
 
 Vielen Dank für die Antwort. Die HTMLs werden wohl kaum zu einem Package gehören. Da die beiden PODs im selben Verzeichnis liegen, werden dies wohl auch die beiden daraus generierten HTMLs tun. Daher sehe ich gute Chancen, dass in myproc_basic.pod L<myproc_details.html> funktionieren könnte. Ich probier's mal aus.
 
 Was die Anker angeht, so glaube ich mich zu erinnern, dass man dafür den Text von =headx nehmen kann. Ich sehe mir mal die HTML-Source von bei mir installierten CPAN-Modulen an.
 Gruß
 GUIfreund
 - +9 replies
 - guest gast2
 
 2012-09-10 12:29
 
 ungestestet: vielleicht eher L<file://....>
 Last edited: 2012-09-10 12:43:33 +0200 (CEST)
 - GUIfreund
 
 2012-09-10 13:51
 
 User since
 2011-08-08
 559 articles
 BenutzerIn
 
 Guest gast2
 ungestestet: vielleicht eher L<file://....>
 
 Mag sein. Könnte aber auch ein Missverständnis deinerseits sein. Der Link, von dem pq und ich sprechen, steht im POD-Text. Das L<file://....> sieht mir eher nach einem Link im HTML-Source aus. Um den brauche ich mich (hoffentlich) nicht zu kümmern, da mein HTML automatisch aus dem POD erzeugt wird. Ich probier's mal aus. Auf jeden Fall danke für den Hinweis.
 Gruß
 GUIfreund
 - +7 replies
 - GUIfreund
 
 2012-09-10 17:32
 
 User since
 2011-08-08
 559 articles
 BenutzerIn
 
 Guest gast2
 ungestestet: vielleicht eher L<file://....>
 
 Du hast Recht. Folgende Schreibweisen funktionieren (mit Windows XP):
 
 Code: (dl )
 
 1 2
 
 L<file://U;/..../myproc_details.html> L<file:///U;/..../myproc_details.html>
 
 Firefox fügt bei Bedarf den 3. Schrägstrich hinzu. Verwendet man
 
 Code: (dl )
 
 L<file:///U;/..../myproc_details.pod>
 
 so wird die POD-Datei im Firefox wie mit einem einfachen Texteditor angezeigt. Ein angefügter Anker führt zu
 Quote
 Datei nicht gefunden
 
 Man muss absolute Pfade verwenden. Damit ist die Aufteilung der Doku auf 2 POD-Dateien für mich gestorben. Für privaten Gebrauch geht das ja, aber wenn ich mein Programm weitergeben will, kann ich nicht wissen, in welchem Pfad die Datei landet, es sei denn, ich würde ein Editieren des Links während der Installation einbauen.
 
 Verweise innerhalb des PODs funktionieren mit der Schreibweise
 
 Code: (dl )
 
 L</anker>
 
 Dabei kann man den Text von =head1 und =head2 als Anker verwenden. Der vollständige Text ist erforderlich, Leerzeichen stören nicht, Groß/Kleinschreibung ist egal.
 
 Nochmals vielen Dank an beide für die Hilfe.
 Gruß
 GUIfreund
 
 +6 replies
 
 topeg
 
 2012-09-11 01:06
 
 User since
 2006-07-10
 2611 articles
 BenutzerIn
 
 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)
 
 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)
 
 +5 replies
 
 pq
 
 2012-09-11 09:36
 
 User since
 2003-08-04
 12209 articles
 Admin1
 
 2012-09-10T23:06:50 topeg
 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
 
 nach cpan? welches?
 wenn das so wäre, müsste es z.b. search.cpan.org oder metacpan.org sein, und jeder link auf dem jeweils anderen server zeigt zu dem einen.
 
 ich denke schon eher, dass es relative links sind. wann hast du das das letzte mal versucht?
 pod2html hat eine option --htmlroot. das schaut mir sehr nach der richtigen aus.
 Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live. -- Damian Conway in "Perl Best Practices"
 lesen: Wie frage ich & perlintro brian's Leitfaden für jedes Perl-Problem
 
 +4 replies
 
 topeg
 
 2012-09-11 10:25
 
 User since
 2006-07-10
 2611 articles
 BenutzerIn
 
 L<NON::EXISTING::PACKAGE>wird zu
 
 Code: (dl )
 
 1 2
 
 <a href="http://search.cpan.org/perldoc?NON%3A%3AEXISTING%3A%3APACKAGE" class="podlinkpod" >NON::EXISTING::PACKAGE</a>
 
 Gerade probiert mit Pod::Simple::HTML
 Ich benutze es weil ich damit den Inhalt mittels CSS formatieren kann. Zudem ist es nicht unpraktisch wenn auf offizielle Pakete verwiesen wird.
 
 Und ja pod2html ----htmlroot=. konvertiert Paketnamen lokal von L<NON::EXISTING::PACKAGE>nach
 
 Code: (dl )
 
 <a href="./NON/EXISTING/PACKAGE.html">the NON::EXISTING::PACKAGE manpage</a>
 
 Es macht aber auch Probleme. L<test.pod> kann nicht aufgelöst werden.
 
 Code: (dl )
 
 /usr/bin/pod2html: index.pod: cannot resolve L<index.pod> in paragraph 4.
 
 Zudem stört es mich dass Links andere Verzeichnisse verweisen. Meine Lösung mit dem konvertieren von "::" nach "_" finde ich persönlich besser. Damit habe ich alle Dateien in einem Verzeichnis. Das macht das Handhaben von CSS einfacher.
 
 +3 replies
 
 GUIfreund
 
 2012-09-11 13:10
 
 User since
 2011-08-08
 559 articles
 BenutzerIn
 
 Gerade wollte ich den Erledigt-Haken für den Thread setzen, da wird's noch mal interessant. Ich werde erst mal sehen, wie ich mit dem Skript von topeg klarkomme. Mein POD enthält auch einen Abschnitt DEPENDENCIES. Hier sollen die Links zum CPAN zeigen. Mal sehen, was das Skript von topeg da macht.
 
 Wenn ich das Skript nicht verwende, sehe ich z. Zt. noch 2 andere Möglichkeiten:
 
 Mit einem dedizierten Perl-Skript tausche ich die Links im HTML-Source aus.
 Ich hänge meine beiden PODs an existierende Module an. Das sieht zwar im Source blöd aus, aber der Benutzer merkt davon nichts.
 
 Apropos DEPENDENCIES: Da habe ich 2 Links:
 
 Code: (dl )
 
 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 
 Legende: Zeile im POD Fehlermeldung von pod2html Eintrag im HTML Ergebnis der manuellen CPAN-Suche =item * L<List::MoreUtils|List::MoreUtils> (keine) <li><a name="list_moreutils_list_moreutils" class="item"><a href="/List/MoreUtils.html">List::MoreUtils</a></a></li> http://search.cpan.org/~adamk/List-MoreUtils-0.33/lib/List/MoreUtils.pm =item * L<PerlE<sol>Tk|Tk> cannot resolve L<PerlE<sol>Tk|Tk> in paragraph 119. <li><a name="perl_tk_tk" class="item">Perl/Tk</a></li> http://search.cpan.org/~srezic/Tk-804.030/pod/overview.pod =item * L<PerlE<sol>Tk|Perl/Tk> cannot resolve L<PerlE<sol>Tk|Perl/Tk> in paragraph 119. <li><a name="perl_" class="item">Perl/Tk</a></li> http://search.cpan.org/~srezic/Tk-804.030/pod/UserGuide.pod
 
 Das Ergebnis des Links zu Tk bzw. Perl/Tk ist einfacher Text (fett und kursiv). List::MoreUtils ist ein Link. Zeigt man darauf, so zeigt Firefox file:///List/MoreUtils.html an. Beim Anklicken passiert nichts. Hat jemand eine Idee, wie ich diese Links richtig schreiben sollte?
 Gruß
 GUIfreund
 
 +2 replies
 
 GUIfreund
 
 2012-09-30 14:18
 
 User since
 2011-08-08
 559 articles
 BenutzerIn
 
 Geschafft - dank des Tools von topeg zeigen jetzt alle Links in meiner Doku dahin, wo sie sollen.
 
 An topeg: Vielen Dank, dass du dein Tool zur Verfügung gestellt hast, und auch dafür, dass du bereitwillig auf meine Erweiterungswünsche eingegangen bist.
 Gruß
 GUIfreund
 
 topeg
 
 2012-09-30 14:41
 
 User since
 2006-07-10
 2611 articles
 BenutzerIn
 
 Ich will mit den Code nicht hinterm Berg halten. Im Anhang die aktuelle Version.
 Attachments
 
 text/plain
 712 lines
 create_html_docu3.pl

View all threads created 2012-09-08 12:36.