My favorites | Sign in
Google
             
New issue | Search
for
| Advanced search | Search tips
Issue 116: table of contents in wiki pages
155 people starred this issue and may be notified of changes. Back to list
Status:  Fixed
Owner:  ningerso
Closed:  Oct 2008
Type-Enhancement
Priority-Medium
Milestone-2008-Q2
Component-Wiki


Sign in to add a comment
 
Reported by killercup, Jan 28, 2007
For long wiki pages it might be good to insert a table of contents. the
user should add it by using e.g. "#tableofcontents".
and to link to a specific part of a wiki page, anchors for the headings
might be good (and afaik they are also needed for the table of contents!)
Comment 1 by ajiaojr, Apr 10, 2007
+1
Comment 2 by krzysztof.lichota, Jun 10, 2007
I agree, I really miss this feature from other wikis.
It saves a great amount of time.
Comment 3 by jrobbins, Jul 02, 2007
(No comment was entered for this change.)
Labels: -Type-Defect Type-Enhancement
Comment 4 by fitz, Jul 05, 2007
(No comment was entered for this change.)
Labels: Milestone-2008 Component-Wiki
Comment 5 by billiej...@gmail.com, Jul 12, 2007
+1
It could be useful also for the Home Page.
Comment 6 by sashulika, Jul 26, 2007
+1
Comment 7 by alek.silverstone, Aug 13, 2007
+1
Comment 8 by alexkon, Aug 27, 2007
See also  issue #288  regarding automatic heading numbering.
Comment 9 by ondrej.certik, Sep 13, 2007
+1
Comment 10 by seba.wag...@gmail.com, Sep 24, 2007
+1
Comment 11 by billiej...@gmail.com, Oct 24, 2007
Any word on if/when this will be fixed?
Comment 12 by phrakt, Oct 24, 2007
It says Milestone-2008, don't hold your breath!
Comment 13 by janpolsen, Oct 24, 2007
Where can we sign up to help developing? :)
Comment 14 by billiej...@gmail.com, Oct 24, 2007
True... :)
I don't want to be rude but a lot of enhancement proposals which are starred by a lot
of users are stagnant from the beginning of year 2007. This is not encouraging... :-\
Comment 15 by jrobbins, Oct 24, 2007
Hey guys.  Thanks for your enthusiasm. We are definitely working on the most-starred
issues first, and this one is in the top 10.  Stay tuned for more user-visible
functionality over the next several weeks. 
Comment 16 by janpolsen, Oct 24, 2007
Awesome Jason... Thanks for the notice. I'm definetly looking forward to some "action" :)
Comment 17 by genosonic, Nov 17, 2007
+1
Comment 18 by sonic5.ttb, Dec 04, 2007
+1
Comment 19 by matthewglinski, Dec 09, 2007
+5
Comment 20 by virsir, Dec 25, 2007
+1
Comment 21 by michaelbibby, Jan 17, 2008
+1
Comment 22 by nurierdemtrt, Jan 31, 2008
help.....................
Comment 23 by castano, Feb 03, 2008
You can create a table of contents manually using internal links:

  * [ApiDocumentation#Introduction Introduction]
  * [ApiDocumentation#Usage Usage]
  * [ApiDocumentation#Input_Options Input Options]

See for example:

http://code.google.com/p/nvidia-texture-tools/wiki/ApiDocumentation
Comment 24 by krzysztof.lichota, Feb 03, 2008
Thanks for the tip! :)
AFAIR anchors were not supported some time ago.

One note about anchors as it was not clear from your comment: it is not necessary to
add them manually, they are created by substitution of spaces in title with
underscores, like in example above:
ApiDocumentation#Input_Options is link to subsection called "Input Options".
Comment 25 by broofa, Feb 03, 2008
@jrobbins:  Any update on when this might be available?  It seems a little odd that
the  most-starred issue in this project has yet to be "accepted", even though it's
been open for over a year.

You did say, "stay tuned" back in October, after all... :)
Comment 26 by germano.rizzo, Feb 03, 2008
@castano: I think it's an issue of the anchor system, but AFAICS this don't work if
the title text contains '?', '.', ',', '!'. It's quite bad, because in a FAQ, for
example, you just can't avoid a '?'.

The thing is, a title like

'Anyone here?'

gets anchored with

<a id="Anyone_here?"/>

but the following:

[FAQ#Anyone_here? Anyone here?]

isn't a valid wiki link. Am I getting something wrong?
Comment 27 by jrobbins, Feb 03, 2008
broofa: We are certainly working on addressing the highly starred issues.  We are
working on this one now, but we have a lot of user-visible and behind-the-scenes work
going on in parallel so each takes time.  And, we are addressing this one as part of
a larger wiki upgrade that will allow us to resolve many wiki enhancement requests. 
Status: Started
Owner: jrobbins
Comment 28 by justin.forest, Feb 04, 2008
Non-latin Unicode characters in the anchor part don't work also.
Comment 29 by broofa, Feb 04, 2008
@germano.rizzo, justin.forest, and krzysztof.lichota (et al):

Bugs with the anchor system are not w/in the scope of this issue.  I've created  issue
#721  to address the problems that have been reported here.  Please continue any
related discussion over there (since comments here are email'ed to the 80+ people who
have starred this issue... many of whom, like me, probably don't consider Castano's
solution to be a viable workaround.)

Thanks.
Comment 30 by billiej...@gmail.com, Mar 12, 2008
Are there some news?
Comment 31 by azmatalipasha, May 07, 2008
(No comment was entered for this change.)
Owner: ningerso
Labels: -Milestone-2008 Milestone-2008-Q2
Comment 32 by tomcioj, May 09, 2008
+1
Comment 33 by tantao700, May 17, 2008
+1
Comment 34 by Cooky.Lovy, May 25, 2008
Agree
Comment 35 by landersk, May 25, 2008
+!

Any update on this?
Comment 36 by mierle, May 27, 2008
+1

We need this for our project!
Comment 37 by sssilver, May 30, 2008
+1
Comment 38 by michaelbibby, May 30, 2008
+1
Comment 40 by stenbryggen, Jun 19, 2008
+1
Comment 41 by martinahansen, Jun 29, 2008
+1
Comment 42 by mr.rohrmoser, Jun 30, 2008
+1
Comment 43 by harshad.rj, Jun 30, 2008
_Please_ stop these mindless   +1  comments
Doesn't serve any purpose other than spamming our mailbox

Just "star" the issue, and that serves the purpose better.
Comment 44 by mnijph, Jun 30, 2008
+1 to harshad.rj!

No, but really, I get this my e-mail. Starring is definitely better for my inbox. Thanks.
Comment 45 by svofski, Jun 30, 2008
Yeah everybody, let's write full of sense +1's to #43 instead of mindless plain +1's.
Comment 46 by broofa, Jun 30, 2008
Instead of spamming this list with more anti-"+1" comments, please star  Issue #677  ,
'Discourage "+1" comments.' to let Google know this is a problem that needs to be
addressed.  Thanks.
Comment 47 by gnewsg2, Jun 30, 2008
Adding +1 comments is the only choice users have to ask google staff to put more
interest on working on requests they opened since a long time.
I can understand that receiving mail notifications for nothing but "+1" messages
could be frustrating but also seeing so few progress concerning this service is
frustrating.

As for this same issue, it is opened since Jan 28 2007 and it's the most starred one
but it seems that no visible progresses have been made ever since.

Comment 48 by genosonic, Jun 30, 2008
It was meant to be finished on the 2nd quarter of this year, if I'm not mistaken, but
it's been quite a while and this is a very important feature. I'm still hoping it
doesn't get postponed. We're already in the 2nd quarter of 2008 and 1 month away from
the 3rd quarter.
Comment 49 by mnijph, Jul 01, 2008
My comment was meant to a bit of a joke, but a sensible one. Anyone browsing issues
will likely scroll through the most starred ones for relevance first (I know I do, at
least). Perhaps we should address /why/ people are posting +1 endlessly, which as
gnewsg2 mentioned, is a lack of visible progress.

Genosonic is right that it is an important issue to everyone, and perhaps a test case
for what users do when left in the dark about progress by the devs. Perhaps dropping
in on high-volume (heavily starred?) issues periodically with updates would help with
the mindless +1 traffic.
Comment 50 by rodolfo.borges, Jul 01, 2008
"what users do when left in the dark about progress by the devs"

What about moving to a Free-software solution?  Then you will never be left in the
dark, you can go on and fix it yourself.
Comment 51 by udo.spallek, Jul 05, 2008
(No comment was entered for this change.)
Comment 52 by jrobbins, Aug 01, 2008
rodolfo.borges: see /p/longhouse/

Comment 53 by mcored, Sep 20, 2008
Quotting broofa: One more vote for TableOfContents support.

Also, the ability to link to sections (headings) within a document would be very
useful - I really would like this feature. 

Comment 54 by KaiGai.Kohei, Oct 20, 2008
vote +1;

I also want this feature. Like a `TableOfContents(int level)` is very 
useful/desirable.

What is the current status?
Comment 55 by MarvinToll, Oct 25, 2008
A table of contents on a page is a core requirement for a Wiki.  This 
implementation, after just a few days, seems to be like procurring a car only to 
find out it has no brakes.  For some reason, I PRESUMED that brakes were included so 
never explicitly asked the question before setting up my open source project at 
Google Code.
Comment 56 by hattingh.fredre, Oct 25, 2008
I would also like to see the feature but until the developers get around to it here
is a Perl script that I use from my project to generate a table of contents. Maybe it
can be useful to someone else: 
http://fredreh.wordpress.com/my-projects/gtoc/
  
Comment 57 by pphaneuf, Oct 25, 2008
@MarvinToll: While I would like to have a table of content as well, I would like to
point out that the original wiki still doesn't have them, so saying that they are a
"core requirement" might be a bit much...
Comment 58 by rodolfo.borges, Oct 25, 2008
Just like multi-level undo on a text editor.

It's not a "core requirement", but it is a expected feature for a decent text editor.
Comment 59 by xiangnan0308, Oct 28, 2008
It says Milestone-2008, don't hold your breath!

Comment 60 by ningerso, Oct 28, 2008
A table of contents can be added to a page with the following syntax:

{{{
<wiki:toc/>
}}}

You can also limit the header depth included in the table of contents by adding a
max_depth parameter:

{{{
<wiki:toc max_depth="1"/>
}}}

We will be updating documentation to cover this feature. 
Status: Fixed
Comment 61 by cbcurl, Oct 28, 2008
Don't you mean just:

<wiki:toc/>

without the {{{}}}?

Comment 62 by svofski, Oct 28, 2008
It's clearly without the {{{}}}. Wow, google, what happened? Nobody here really 
expects you to fix the most starred issues anymore.
Comment 63 by arthur.kalm, Oct 28, 2008
ningerso put the {{{}}} because he thought it would be wikified and turned into code
so it looks a little better. Unfortunately wiki formatting isn't supported in comments.
Comment 64 by good.midget, Oct 28, 2008
Where's the love?  Even though it's taken a seemingly inordinate amount of time to
get this feature implemented, I would like to say *thank you!* ... once more ...
THANK YOU!  I'm certain this will improve the overall quality of documentation in
project wikis.  So, thank you!
Comment 65 by plorenz, Oct 28, 2008
Thank you for implementing this.

Just a note, in case you were unaware of this quirk: I had a section title with
markup in it, like

===Foo `bar`===

The `bar` was stripped out of the table of contents and showed as just Foo
Comment 66 by ggventurini, Oct 28, 2008
After a quick test, it looks like if there are two identical titles at different 
levels they both correctly show up in the TOC, but they both refer to the same one.

Thanks for fixing this, anyway.
Comment 67 by stinger911, Oct 28, 2008
Thanks! Great feature!
Comment 68 by djreimer, Oct 28, 2008
Great to see this after the long wait! Kudos, and thanks!
Comment 69 by nicolas.alvarez, Oct 28, 2008
Re: comment 66: I believe Wikipedia has the same problem, at least if you manually
make a link to an anchor.
Comment 70 by schultzter, Oct 28, 2008
Wooohooo!  Thank you.
Comment 71 by T.Delenikas, Oct 28, 2008
Thank you!
Comment 72 by T.Delenikas, Oct 28, 2008
...and a small bug for you:

Camel-noted words seem to create some problem. See 
[http://code.google.com/p/smslib/wiki/SMSServer_Gateways here].
Comment 73 by aggraef, Feb 25, 2009
<wiki:toc> suddenly stopped working for me. No toc shown any more. Did anyone else
notice this? Can anyone help?
Comment 74 by miika.ahonen, Feb 25, 2009
It's <wiki:toc/> with the ending slash.
Comment 75 by aggraef, Feb 25, 2009
Yes, that's what I actually have (typo was only in my message), e.g., here:
http://code.google.com/p/pure-lang/wiki/Addons (svn here:
http://code.google.com/p/pure-lang/source/browse/wiki/Addons.wiki)

It used to work. But suddenly *all* my wiki pages lost their tocs, without changing
anything AFAICT.
Comment 76 by jrobbins, Feb 25, 2009
This feature was implemented and it was working for a while, but then we had a
regression defect that made it stop working.  That is being tracked in  issue 2261 .
You may want to star that issue. We have a fix ready, but that fix has not been
deployed to the live servers yet.
Sign in to add a comment