Re: Perl DOC BOF
On Mon, 30 Jul 2001, Me wrote: 2. Format (quick to read, quick to write docs that link together; 2 paragraph intro that becomes a daily tip) Are thinking of making a wiki a key part of the overall picture? If you are, and need one customized, lemme know. I can add stuff to WebWebX (http://ibiblio.org/webwebx) specifically if it's needed. --- Joe M.
Re: Perl DOC BOF
On Sun, Jul 29, 2001 at 12:48:54AM -0400, Bryan C . Warnock wrote: Okay, fun's over. Back to work. There was a Perl Documentation BOF that was scheduled for 6:30 Friday; however, it seems none of the folks who showed up actually called it, and none of the folks who called it actually showed up. (Or showed up fairly late - after I had already left.) What was it about? I'm working on some comprehensive Perl 6 reference material for the group, but would like to take into consideration any upcoming changes to how docs are done. Ziggy? You posted the note, but I don't remember for whom. Um. Wow. Casey and I didn't think anyone had seen the notice. The idea was that a few of us interested in the Perl Documentation Project (similarity to the Linux Doc Proj completely intentional) should get together and talk about a few organizational issues. A few people were interested in the PDP at the conference, but by Friday, we thought the message wasn't getting out in enough detail to have a fruitful discussion. Issues that need to be resolved include: 0. Licensing (Casey favors OPL, Bradley strongly urges FDL, with a reliance on copyright law, and I'm the simple son who knows not how to ask...) 1. Target Audience 2. Format (quick to read, quick to write docs that link together; 2 paragraph intro that becomes a daily tip) 3. Document Types (tutorial, howto, faq, what else do we need?) 4. Key areas of focus (perl5 newbies, perl6, whatever) That was it. This discussion will probably take place online sometime in the next month. Z.
Re: Perl DOC BOF
2. Format (quick to read, quick to write docs that link together; 2 paragraph intro that becomes a daily tip) Are thinking of making a wiki a key part of the overall picture?
Re: Perl DOC BOF
I haven't finished this idea yet but, I was talking with Andy Wardley and this may be the idea. Except it will be the Template Toolkit interfacing with wiki which means we can build filters that translate POD. Of course, if the wiki internal format isn't some type of DocBook, it's not going to solve all our problems very well. I was really thinking more of the generic wiki concept (super lightweight online editable hypertext, very much a spiritual cousin of POD), than any particular wiki. I was also thinking about literate programming. Basically, it seems like great timing to make the attempt to partially integrate: 1. POD; 2, An online editable hypertext engine for development of POD; 3. An online editable hypertext engine for discussion of all things; 4. Literate programming; Someone created a literate programming perl wiki that builds itself out of the pages of its wiki. Might be a good thing to look at.
Re: Perl DOC BOF
On Mon, Jul 30, 2001 at 05:21:37PM -0400, David Grove wrote: : On Monday 30 July 2001 17:09, Me wrote: : 2. Format (quick to read, quick to write docs that link together; : 2 paragraph intro that becomes a daily tip) : : Are thinking of making a wiki a key part of the overall picture? : : If ya do, make it understand POD and not the normal wikiyikky markup gunk. I haven't finished this idea yet but, I was talking with Andy Wardley and this may be the idea. Except it will be the Template Toolkit interfacing with wiki which means we can build filters that translate POD. Of course, if the wiki internal format isn't some type of DocBook, it's not going to solve all our problems very well. More on this later ;-) Casey West -- Shooting yourself in the foot with Linux Generous programmers from around the world all join forces to help you shoot yourself in the foot for free.
Re: Perl DOC BOF
Ziggy wrote: On Sun, Jul 29, 2001 at 12:48:54AM -0400, Bryan C . Warnock wrote: There was a Perl Documentation BOF that was scheduled for 6:30 Friday; however, it seems none of the folks who showed up actually called it, and none of the folks who called it actually showed up. (Or showed up fairly late - after I had already left.) D'oh! I missed hearing about it... and was probably too wiped out by then to be useful anyway. 0. Licensing (Casey favors OPL, Bradley strongly urges FDL, with a reliance on copyright law, and I'm the simple son who knows not how to ask...) 1. Target Audience 2. Format (quick to read, quick to write docs that link together; 2 paragraph intro that becomes a daily tip) 3. Document Types (tutorial, howto, faq, what else do we need?) 4. Key areas of focus (perl5 newbies, perl6, whatever) That was it. This discussion will probably take place online sometime in the next month. Well, count me in, in a general sense. I'm not sure I have anything particularly productive to add right now, though. K. -- Kirrily 'Skud' Robert - [EMAIL PROTECTED] - http://infotrope.net/ Death before decaf.
