Browser di documentazione Perl (POD)?

Sto cercando è una buona esperienza di lettura POD su schermo.Browser di documentazione Perl (POD)?

Per anni, ho usato perldoc o man in esecuzione in un xterm di leggere la documentazione Perl su schermo, e un piccolo programma personalizzato costruito intorno Pod::LaTeX per stamparlo. La versione stampata è buona: lo script fa un buon lavoro. Tuttavia, sullo schermo lettura è dolorosa:

È possibile cercare, ma buona fortuna trovare per esempio, la sezione as in DBIx::Class::ResultSet. Meno non sa nulla della struttura del documento, e le ricerche di parole inglesi comuni sono inutili.
Ho paura ogni volta che il documento mi dice see section so-and-so. Grande. Ora devo trovarlo. E poi tornare al punto in cui mi trovavo non sarebbe banale (anche se potrebbe essere la mia minore ignoranza)
Vedere il documento così e così è peggio. !perldoc foo funziona, ma passare tra i due documenti è quindi difficile. Per lo più è possibile aggirare il problema sospendendo di meno ed eseguendo perldoc dalla shell, ma questo è più un numero di sequenze di tasti e io sono pigro.
La formattazione lascia molto a desiderare.

Desidero poter fare clic su un indice e andare a quella sezione. Voglio poter fare clic su "vedere altro" e andare lì. E così via. Finora, io so di due possibilità:

search.cpan.org, ad esempio DBIx::Class::ResultSet. Richiede una connessione Internet, ma normalmente non è un problema.
Podbrowser. Ho appena iniziato a provarlo, sembra molto carino.

Sto eseguendo Debian GNU/Linux, sia Lenny che Squeeze. Ma ti preghiamo di suggerire programmi per tutte le piattaforme per renderlo il più utile possibile.

fonte

2009-10-02 derobert

Un sacco di cose di cui ti lamenti sono le cose che faccio solo in una finestra terminale separata (o schermo, o qualsiasi altra cosa). Anche a me non interessa tanto la formattazione. :) –

Si può provare Pod::Browser che è il server http integrato che è possibile connettersi con il browser, o qualcosa come Tk::Pod che è il browser gui pod.

fonte

2009-10-02 15:21:29 mpeters

Quindi sai, il tuo primo link è morto. – ale10ander

@Cptn_Hammer risolto per mpeters – derobert

avrei recomment convertire tutto il vostro POD per HTML usando pod2html

In questo modo è sfogliabile, legata e bella, ed è possibile personalizzare aspetto & sentire tramite CSS.

fonte

2009-10-02 15:15:37 DVK

Questo è quello che uso, dato che è utile quando disconnesso dalla rete ed è altrettanto utilizzabile dalla linea di comando con lynx (bit purtroppo non è nella distribuzione standard di MacOSX, ma Macports ce l'ha). Mi chiedo se è possibile impostare una preferenza ExtUtils :: MakeMaker per creare documenti html per impostazione predefinita per tutte le installazioni ...? – Ether

Avete visto CPAN::Mini::Webserver o Pod::POM::Web o Apache::Perldoc? Questi impostano un modo locale per farti vedere le belle versioni HTML dei tuoi documenti.

fonte

2009-10-02 16:07:06

Solo per aggiungere altri due server POD che sembravano mancare finora!

fonte

2009-10-03 16:21:25 draegtun

Cosa c'è da scegliere tra queste varie opzioni – justintime

@justintime: Non usato Pod :: Webserver quindi non posso commentare in merito. Ma io uso Pod :: Server e ne sono stato molto contento. Mi piace il modo in cui rende il POD e perché è basato sul framework di Squatting mi sento a mio agio sapendo che posso apportare modifiche locali se necessario (cosa che non ho finora ... ma aggiungere un'opzione di ricerca sarebbe una buona idea!) . – draegtun

Date un'occhiata anche Gtk2 :: :: Ex PodViewer che è un visualizzatore di grafica eccellente basata su GTK. Se utilizzi anche Windows puoi trovare un wrapper precostruito in Camelbox (http://code.google.com/p/camelbox/).

fonte

2011-03-15 10:28:03 register

A prima vista, podviewer (v0.18, che CPAN dice è l'ultimo) sembra un podbrowser meno lucido. – derobert

Browser di documentazione Perl (POD)?

risposta

Problemi correlati