_brian_d_foy wrote in perl.documentation: > How has perlfaq.pod been generated in the past? if nobody has a > programmatic solution already, i want to create one. > > i noticed that some new answers were not in perlfaq.pod, so i wrote a > script to generate it from the other POD files. from that, i noticed a > lot of little differences, such as capitalization and punctuation, so i > fixed those, improved my script, rinsed, and repeated. > > i still need to fix a couple of edge cases, but if someone has already > done that, i won't worry about it. > > also, if we do use something to generate perlfaq.pod, where should that > live? should it be in CVS with the perlfaq*.pod? how about a > Makefile as well? should perlfaq.pod then disappear, or be replaced > by a template?
I think you should mimic what's done currently for perlmodlib.pod. It's generated by a script pod/perlmodlib.PL (in the perl source distribution), and has a make target in pod/Makefile (don't update pod/Makefile directly, update pod/Makefile.SH). Name your script pod/perlfaq.PL, and have it included by Jarrko into bleadperl. > furthermore, since many of the differences i fixed were matters of > style, should we have a style guide for the documentation? i'm willing > to do the initial work. i don't necessarily want to set policy, but as more > and more people work on the documents i'd like to see some guidance > on the writing issues. the initial style guide can simply be the current > style codified. :) -- Rafael Garcia-Suarez
