in reply to Re: Perl Module Documentation
in thread Perl Module Documentation

Via /msg:

ww says Re Re^2: Perl Module Documentation -d -T -o and note carefully that I said "starting point" -- NOT, here's a script to do the conversion

Those options certainly did not stand out to me as a mechanism by which the OPs question could be solved.

And even now you pointed them out I still wouldn't have a clue how to use them to solve his problem.

Perhaps you would consider supplying a little more info on how to go about it?

I asked because I would very much like to know how to do this. I have and use daily, minute by minute, the AS HTML treeview built by AS. But:

  1. it only includes modules installed by PPM, not those I build/install via other mechanisms;
  2. it includes POD for a whole bunch of stuff from the AS & standard distribution that I'm not interested in and would like to exclude.

    Eg. I Have no use for this lot:

    Or this junk:

    Or this stuff:

    perlbook perlcommunity perltodo perldoc perlhist perldelta perl5101delta perl5100delta perl595delta perl594delta perl593delta perl592delta perl591delta perl590delta perl589delta perl588delta perl587delta perl586delta perl585delta perl584delta perl583delta perl582delta perl581delta perl58delta perl573delta perl572delta perl571delta perl570delta perl561delta perl56delta perl5005delta perl5004delta perlartistic perlgpl perlcn perljp perlko perltw perlaix perlamiga perlapollo perlbeos perlbs2000 perlce perlcygwin perldgux perldos perlepoc perlfreebsd perlhaiku perlhpux perlhurd perlirix perllinux perlmachten perlmacos perlmacosx perlmint perlmpeix perlnetware perlopenbsd perlos2 perlos390 perlos400 perlplan9 perlqnx perlriscos perlsolaris perlsymbian perltru64 perluts perlvmesa perlvms perlvos
  3. and it includes whole heaps of stuff from some modules that I would like to exclude.

    Eg. This junk from Date::Manip

    And this from somewhat similar crap from DateTime :

    Locale aa aa_DJ aa_ER aa_ER_SAAHO aa_ET af af_NA af_ZA ak ak_GH am am_ET ar ar_AE ar_BH ar_DZ ar_EG ar_IQ ar_JO ar_KW ar_LB ar_LY ar_MA ar_OM ar_QA ar_SA ar_SD ar_SY ar_TN ar_YE as as_IN az az_AZ az_Cyrl az_Cyrl_AZ az_Latn az_Latn_AZ Base be be_BY bg bg_BG bn bn_BD bn_IN bo bo_CN bo_IN bs bs_BA byn byn_ER ca Catalog ca_ES cch cch_NG cop cs cs_CZ cy cy_GB da da_DK de de_AT de_BE de_CH de_DE de_LI de_LU dv dv_MV dz dz_BT ee ee_GH ee_TG el el_CY el_GR el_POLYTON en en_AS en_AU en_BE en_BW en_BZ en_CA en_Dsrt en_Dsrt_US en_GB en_GU en_HK en_IE en_IN en_JM en_MH en_MP en_MT en_NA en_NZ en_PH en_PK en_SG en_Shaw en_TT en_UM en_US en_US_POSIX en_VI en_ZA en_ZW eo es es_AR es_BO es_CL es_CO es_CR es_DO es_EC es_ES es_GT es_HN es_MX es_NI es_PA es_PE es_PR es_PY es_SV es_US es_UY es_VE et et_EE eu eu_ES fa fa_AF fa_IR fi fil fil_PH fi_FI fo fo_FO fr fr_BE fr_CA fr_CH fr_FR fr_LU fr_MC fr_SN fur fur_IT ga gaa gaa_GH ga_IE gez gez_ER gez_ET gl gl_ES gsw gsw_CH gu gu_IN gv gv_GB ha haw haw_US ha_Arab ha_Arab_NG ha_Arab_SD ha_GH ha_Latn ha_Latn_GH ha_Latn_NE ha_Latn_NG ha_NE ha_NG ha_SD he he_IL hi hi_IN hr hr_HR hu hu_HU hy hy_AM hy_AM_REVISED ia id id_ID ig ig_NG ii ii_CN is is_IS it it_CH it_IT iu ja ja_JP ka kaj kaj_NG kam kam_KE ka_GE kcg kcg_NG kfo kfo_CI kk kk_Cyrl kk_Cyrl_KZ kk_KZ kl kl_GL km km_KH kn kn_IN ko kok kok_IN ko_KR kpe kpe_GN kpe_LR ku ku_Arab ku_Arab_IQ ku_Arab_IR ku_Arab_SY ku_IQ ku_IR ku_Latn ku_Latn_TR ku_SY ku_TR kw kw_GB ky ky_KG ln ln_CD ln_CG lo lo_LA lt lt_LT lv lv_LV mk mk_MK ml ml_IN mn mn_CN mn_Cyrl mn_Cyrl_MN mn_MN mn_Mong mn_Mong_CN mo mr mr_IN ms ms_BN ms_MY mt mt_MT my my_MM nb nb_NO nds nds_DE ne ne_IN ne_NP nl nl_BE nl_NL nn nn_NO no nr nr_ZA nso nso_ZA ny ny_MW oc oc_FR om om_ET om_KE or or_IN pa pa_Arab pa_Arab_PK pa_Guru pa_Guru_IN pa_IN pa_PK pl pl_PL ps ps_AF pt pt_BR pt_PT ro root ro_MD ro_RO ru ru_RU ru_UA rw rw_RW sa sa_IN se se_FI se_NO sh sh_BA sh_CS sh_YU si sid sid_ET si_LK sk sk_SK sl sl_SI so so_DJ so_ET so_KE so_SO sq sq_AL sr sr_BA sr_CS sr_Cyrl sr_Cyrl_BA sr_Cyrl_CS sr_Cyrl_ME sr_Cyrl_RS sr_Cyrl_YU sr_Latn sr_Latn_BA sr_Latn_CS sr_Latn_ME sr_Latn_RS sr_Latn_YU sr_ME sr_RS sr_YU ss ss_SZ ss_ZA st st_LS st_ZA sv sv_FI sv_SE sw sw_KE sw_TZ syr syr_SY ta ta_IN te te_IN tg tg_Cyrl tg_Cyrl_TJ tg_TJ th th_TH ti tig tig_ER ti_ER ti_ET tl tn tn_ZA to to_TO tr trv trv_TW tr_TR ts ts_ZA tt tt_RU ug ug_Arab ug_Arab_CN ug_CN uk uk_UA ur ur_IN ur_PK uz uz_AF uz_Arab uz_Arab_AF uz_Cyrl uz_Cyrl_UZ uz_Latn uz_Latn_UZ uz_UZ ve ve_ZA vi vi_VN wal wal_ET wo wo_Latn wo_Latn_SN wo_SN xh xh_ZA yo yo_NG zh zh_CN zh_Hans zh_Hans_CN zh_Hans_HK zh_Hans_MO zh_Hans_SG zh_Hant zh_Hant_HK zh_Hant_MO zh_Hant_TW zh_HK zh_MO zh_SG zh_TW zu zu_ZA

    And there's more. Much, much more!

  4. I can manually trim these out, but the next time I install a module with PPM, it rebuilds it all and everything reappears. I would really like to find a way to produce an HTML doc stack of just the bits of POD that I find useful.

So you see. My question was not an idle one, but actually an attempt to illicit further info on how to go about this.

The said. RTFM replies are only really useful if the information asked for is there and obvious and likely to be both recognised and understood by the OP. And despite the time I've been around Perl, your post did not help me answer the question.


With the rise and rise of 'Social' network sites: 'Computers are making people easier to use everyday'
Examine what is said, not who speaks -- Silence betokens consent -- Love the truth but pardon error.
"Science is about questioning the status quo. Questioning authority".
In the absence of evidence, opinion is indistinguishable from prejudice.

The start of some sanity?

Replies are listed 'Best First'.
Re^3: Perl Module Documentation
by ww (Archbishop) on Dec 20, 2011 at 20:45 UTC
    Sorry; I thought you were gratuitously "bustin' my chops;" I see differently now and apologize for the deficiencies in my reply. They were numerous.

    The options I mentioned allow you to selectively produce a plain text file (formatted with spaces and newlines) of the relevant doc (and pod, TBOMK) using a CLI command like this (under Win):

    F:\pl_docs>perldoc -d nextpod.out -T -o f next Perldoc (Pod::Perldoc::ToText) output saved to nextpod.out

    The -d argument is the outfile name; -T says "don't page" and -o can specify a format, but is not something I've played with seriously. (Note, NO hyphen before the "f" preceding the function name. I have no clue why it works that way.)

    From there, wrap the output in minimal html,

    html <head> <title> <!-- (module or function title) --> </title> </head> <body> <pre> <!-- (content of your output from above, verbatim) --> </pre> </body> </html>

    However, automating the above in a script may be more work than I've considered. Making the .html 'semantic' would certainly be more work.

    So, in all honesty (/me flushes with pseudo-embarassment and pride at his self-congratulatory caveat), RichardK's pointer to Pod::Webserver now seems likely to be a far better way to do the job, unless it's bug-ridden. And in further honesty, you're right about needing to be obvious -- I just thought it would be to a Monk as experienced and wise (if sometimes, a tad sharp with others) as you. But since the post will stand for others, apologies, also, for failing to follow that guidance.

    But, afterthought, would you please stick <c>readmore<c>s in there somewhere?

      But, afterthought, would you please stick readmores in there somewhere?

      As all the long stuff is wrapped in <spoiler> tags, you should not be seeing any of it unless you explicitly click one of the links in: <Reveal this spoiler or all spoilers in this node or all in this thread>.

      Whereas, if I had used <readmore>'s, everyone would have to suffer it all as soon as they opened the post.


      With the rise and rise of 'Social' network sites: 'Computers are making people easier to use everyday'
      Examine what is said, not who speaks -- Silence betokens consent -- Love the truth but pardon error.
      "Science is about questioning the status quo. Questioning authority".
      In the absence of evidence, opinion is indistinguishable from prejudice.

      The start of some sanity?