Bug #34161 for Pod-WikiDoc: RFE: item list

Mon Mar 17 10:21:24 2008 g.grigelionis [...] gmail.com - Ticket created

Subject:	RFE: item list
Date:	Mon, 17 Mar 2008 15:20:03 +0100
To:	bug-Pod-WikiDoc [...] rt.cpan.org
From:	"Gintautas Grigelionis" <g.grigelionis [...] gmail.com>

Hello, I can't see the way to achieve =item foo bar or =item foo =over =item bar baz =back in WikiDoc. I'm not a Wiki user so I have no immediate suggestion for WikiDoc syntax (maybe Show quoted text

> "foo" bar

), but I see WikiDoc as very useful way of documenting all kinds of source files (in my case, Makefiles) and producing pod of them. Kind regards, Gintas

Wed Mar 19 05:24:36 2008 dagolden [...] cpan.org - Correspondence added

Those are great suggestions. I've been meaning to implement support for "=item foo" lists, but haven't gotten around to it. Nested lists, however, are a bit more difficult to parse so that probably won't happen for a while. Thank you very much for your suggestions! David

Wed Mar 19 05:24:39 2008 The RT System itself - Status changed from 'new' to 'open'

Wed Mar 19 05:48:40 2008 g.grigelionis [...] gmail.com - Correspondence added

Subject:	Re: [rt.cpan.org #34161] RFE: item list
Date:	Wed, 19 Mar 2008 10:47:56 +0100
To:	bug-Pod-WikiDoc [...] rt.cpan.org
From:	"Gintautas Grigelionis" <g.grigelionis [...] gmail.com>

Thanks for the answer, I wish I had some time to hack the parser :-) Still, I had some time to check out wiki syntax references like http://www.usemod.com/cgi-bin/mb.pl?WikiMarkupStandard and http://jamwiki.org/wiki/en/Wiki_Syntax; I think the latter has a useful suggestion for nested lists. I retract my suggestion in favor of ; foo : bar and ; foo : ;0 bar ;0 baz etc (or something of that sort). There is another problem with "*" being overloaded as bullet and bold markup. I'd suggest changing to "-" for bullets. What do you think ? Gintas 2008/3/19, David Golden via RT <bug-Pod-WikiDoc@rt.cpan.org>: Show quoted text

> > > <URL: http://rt.cpan.org/Ticket/Display.html?id=34161 > > > Those are great suggestions. I've been meaning to implement support for > "=item foo" lists, but haven't gotten around to it. Nested lists, > however, are a bit more difficult to parse so that probably won't happen > for a while. > > Thank you very much for your suggestions! > > David >

Wed Mar 19 06:03:27 2008 dagolden [...] cpan.org - Correspondence added

Subject:	Re: [rt.cpan.org #34161] RFE: item list
Date:	Wed, 19 Mar 2008 06:03:07 -0400
To:	bug-Pod-WikiDoc [...] rt.cpan.org
From:	"David Golden" <dagolden [...] cpan.org>

On Wed, Mar 19, 2008 at 5:48 AM, Gintautas Grigelionis via RT <bug-Pod-WikiDoc@rt.cpan.org> wrote: Show quoted text

> Thanks for the answer, I wish I had some time to hack the parser :-) Still, > I had some time to check out wiki syntax references like > http://www.usemod.com/cgi-bin/mb.pl?WikiMarkupStandard and > http://jamwiki.org/wiki/en/Wiki_Syntax; I think the latter has a useful > suggestion for nested lists. I retract my suggestion in favor of > > ; foo : bar > > and > > ; foo : > ;0 bar > ;0 baz > > etc (or something of that sort).

I have been considering either that markup or :foo: bar I don't really like the ;foo: markup -- seems rather pointless to use two different symbols when one could do. The nesting is just about the only reason for it, maybe. Show quoted text

> There is another problem with "*" being overloaded as bullet and bold > markup. I'd suggest changing to "-" for bullets. > What do you think ?

To a great degree, I'm trying to stick with a wiki format similar to Kwiki, so I prefer to stick with * for bullets. It's not so ambiguous for the parser, as a bullet has to be at the start of a line, followed by whitespace and 'line blocks' are parsed first. I've been writing WikiDoc for a while now and haven't had any problems with it. David

Wed Mar 19 06:11:14 2008 g.grigelionis [...] gmail.com - Correspondence added

Subject:	Re: [rt.cpan.org #34161] RFE: item list
Date:	Wed, 19 Mar 2008 11:10:53 +0100
To:	bug-Pod-WikiDoc [...] rt.cpan.org
From:	"Gintautas Grigelionis" <g.grigelionis [...] gmail.com>

":foo: bar" is syntax acceptable for me, but ";foo: bar" is what is used by engines out there; I just looked at Kwiki ( http://www.kwiki.org/?KwikiFormattingRules), and it's OK to stay close to their syntax except that I dislike their nesting rules * foo 00 bar 00 baz * jinx compare more complex cases like * foo *0 bar *0;Test: description this continues description for Test *0;;subtest : sub-definition list for Test and * foo 00 bar ;;;Test: not possible impossible description for Test Gintas 2008/3/19, David Golden via RT <bug-Pod-WikiDoc@rt.cpan.org>: Show quoted text

> > > <URL: http://rt.cpan.org/Ticket/Display.html?id=34161 > > > On Wed, Mar 19, 2008 at 5:48 AM, Gintautas Grigelionis via RT > <bug-Pod-WikiDoc@rt.cpan.org> wrote:

> > Thanks for the answer, I wish I had some time to hack the parser :-)

> Still,

> > I had some time to check out wiki syntax references like > > http://www.usemod.com/cgi-bin/mb.pl?WikiMarkupStandard and > > http://jamwiki.org/wiki/en/Wiki_Syntax; I think the latter has a useful > > suggestion for nested lists. I retract my suggestion in favor of > > > > ; foo : bar > > > > and > > > > ; foo : > > ;0 bar > > ;0 baz > > > > etc (or something of that sort).

> > I have been considering either that markup or > > :foo: bar > > I don't really like the ;foo: markup -- seems rather pointless to use > two different symbols when one could do. The nesting is just about > the only reason for it, maybe. >

> > There is another problem with "*" being overloaded as bullet and bold > > markup. I'd suggest changing to "-" for bullets. > > What do you think ?

> > To a great degree, I'm trying to stick with a wiki format similar to > Kwiki, so I prefer to stick with * for bullets. It's not so ambiguous > for the parser, as a bullet has to be at the start of a line, followed > by whitespace and 'line blocks' are parsed first. I've been writing > WikiDoc for a while now and haven't had any problems with it. > > David > >

Wed Mar 19 06:38:55 2008 dagolden [...] cpan.org - Correspondence added

Subject:	Re: [rt.cpan.org #34161] RFE: item list
Date:	Wed, 19 Mar 2008 06:38:27 -0400
To:	bug-Pod-WikiDoc [...] rt.cpan.org
From:	"David Golden" <dagolden [...] cpan.org>

On Wed, Mar 19, 2008 at 6:11 AM, Gintautas Grigelionis via RT Show quoted text

> compare more complex cases like > > * foo > *0 bar > *0;Test: description > this continues description for Test > *0;;subtest : sub-definition list for Test > > and > > * foo > 00 bar > ;;;Test: not possible > impossible description for Test

I agree. I've also considered an explicit 'nesting' character along these lines. * foo |0 bar ||;Test: description this description continues for test |||;subtest: sub-definition list for test David

Wed Mar 19 11:50:11 2008 g.grigelionis [...] gmail.com - Correspondence added

Subject:	Re: [rt.cpan.org #34161] RFE: item list
Date:	Wed, 19 Mar 2008 16:39:21 +0100
To:	bug-Pod-WikiDoc [...] rt.cpan.org
From:	"Gintautas Grigelionis" <g.grigelionis [...] gmail.com>

2008/3/19, David Golden via RT <bug-Pod-WikiDoc@rt.cpan.org>: Show quoted text

> > > I agree. I've also considered an explicit 'nesting' character along > these lines. > > * foo > |0 bar > ||;Test: description > this description continues for test > |||;subtest: sub-definition list for test > > > David >

If this simplifies parser, so be it :-) It may as well be more aesthetically acceptable in complex situations. Gintas