nested list with rdoc

S

shasckaw

Hello there!
I'm using rdoc version 0.9.0, the one distributed with self-install
windows package, and I can't get any good looking nested list.

I've tried to use this:
* the first item
* the nested item
* the second item

This:
* the first item
* the nested item
* the second item

That:
* the first item
** the nested item
* the second item

And I even tried to mix different kind of lists: *, - or 1.
But none of them gives me satisfaction, in the best case, the nested
list gives a indented preformated block.

The docs on rdoc doesn't help, is this a bug?
If not how should I do? Can someone help me?

Lio
 
D

Dave Thomas

Hello there!
I'm using rdoc version 0.9.0, the one distributed with self-install
windows package, and I can't get any good looking nested list.

I've tried to use this:
* the first item
* the nested item
* the second item

This:
* the first item
* the nested item
* the second item

The '*' from the nested list should be underneath the first character
of the text of it's parent:

* line one
* nested one
* nested two
* line two
The docs on rdoc doesn't help, is this a bug?
If not how should I do? Can someone help me?

There's an example in the README:

1. Lists are typed as indented paragraphs with:
* a '*' or '-' (for bullet lists)
* a digit followed by a period for
numbered lists
* an upper or lower case letter followed
by a period for alpha lists.


Cheers

Dave
 
S

shasckaw

Dave said:
The '*' from the nested list should be underneath the first character of
the text of it's parent:

* line one
* nested one
* nested two
* line two
It finally works, thanks!
There's an example in the README:

1. Lists are typed as indented paragraphs with:
* a '*' or '-' (for bullet lists)
* a digit followed by a period for
numbered lists
* an upper or lower case letter followed
by a period for alpha lists.
I've read it but I must tell I haven't understood it was just a matter
of column alignement. I use wscite for editing ruby and it doesn't align
columns excepted for tabulations. It makes the use of rdoc nested list a
little bit uneasy. If rdoc could also allow nested lists with the use of
tabulations in addition to the column alignement way, it would certainly
help me, and all the ones like me. What do you think about that proposition?

Cheers,
Lio
 
D

Dave Thomas

I've read it but I must tell I haven't understood it was just a matter
of column alignement. I use wscite for editing ruby and it doesn't
align columns excepted for tabulations. It makes the use of rdoc
nested list a little bit uneasy. If rdoc could also allow nested lists
with the use of tabulations in addition to the column alignement way,
it would certainly help me, and all the ones like me. What do you
think about that proposition?

I understand your pain, but the guiding principle behind RDoc is that
the raw source should be universally readable. If tabs are used, and
tab stops aren't aligned at 8-character intervals, then that's no
longer the case.

If someone would like to come up with a patch that added support for
tabs as an option, I'd look at integrating it.


Cheers

Dave
 
S

shasckaw

Dave said:
I understand your pain, but the guiding principle behind RDoc is that
the raw source should be universally readable. If tabs are used, and tab
stops aren't aligned at 8-character intervals, then that's no longer the
case.

If someone would like to come up with a patch that added support for
tabs as an option, I'd look at integrating it.
I'll think about that! ;)

Lio
 

Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Members online

Forum statistics

Threads
474,142
Messages
2,570,819
Members
47,367
Latest member
mahdiharooniir

Latest Threads

Top