[MoodleDoc] Where is the table of content?

[MoodleDoc] Where is the table of content?

by Visvanath Ratnaweera -
Number of replies: 7
Picture of Particularly helpful Moodlers Picture of Translators
I am looking at http://docs.moodle.org/26/en/Messaging. The line above the menu bar confirms that I am logged in. And the -> preferences -> Appearance -> Show table of contents is set. But no table of content visible. Why?

Edit: Found the answer. It says, "(for pages with more than 3 headings)". But why this? I was looking for the deep link like http://docs.moodle.org/26/en/Messaging#Instant_messaging but no way of doing it other than wild guessing.

Could our doc managers please explain?
Average of ratings: -
In reply to Visvanath Ratnaweera

Re: [MoodleDoc] Where is the table of content?

by Mary Cooch -
Picture of Documentation writers Picture of Moodle HQ Picture of Particularly helpful Moodlers Picture of Testers Picture of Translators

Hello Visvanath. Do you mean why "for pages with more than 3 headings"? I don't know why that  particular number was chosen, but I would imagine it was probably thought that for fewer than 3 headings you could see them all on the page and didn't need quick links. As for linking to a particular section, I wouldn't have thought it was "wild guessing" as it seems to me it is the hashtag # and then the title of the section but with underscores _ where the spaces are. ( I personally tend not to link to sections as before I began contributing to docs it used to confuse me when I only saw a section of a page and not its top immediately on first access, so I don't do that deep linking very often.)

However, I need to thank you for prompting me to investigate "this table of contents" because I have just found that if I go to a page and it is open/showing, then if I close it, I cannot then open it again - on Chrome and IE, so I am wondering if there is some theme problem here. I will check tomorrow. The docs, like other community sites, is due a revamp so hopefully such issues can be fixed then.

In reply to Mary Cooch

Re: [MoodleDoc] Where is the table of content?

by Itamar Tzadok -

It's probably the same problem reported by Joseph at Links Display bug in the Documentation wiki. When you collapse the TOC, the 'show' link (and the title) is covered by the span tag of the first heading and so you can't click it. smile

In reply to Mary Cooch

Re: [MoodleDoc] Where is the table of content?

by Visvanath Ratnaweera -
Picture of Particularly helpful Moodlers Picture of Translators
Hi Mary

You wrote:
> Do you mean why "for pages with more than 3 headings"?

Yes. The visibility of a table of contents being an attribute of the user is odd enough. (The user needs to be logged in that particular wiki, and there are ten odd wikis: /19/, /20/, ... /26/ and /dev/.) But I got used to it. Now this three headings rule, can not think of a reason.

> I don't know why that particular number was chosen, but I would imagine it was probably thought that for fewer than 3 headings you could see them all on the page and didn't need quick links.

You know pretty well that web doesn't have pages (paper and slides do). Web is for the screen, and after the invention of elastic interfaces for mobile devices, even that word has lost its meaning.

> As for linking to a particular section, I wouldn't have thought it was "wild guessing" as it seems to me it is the hashtag # and then the title of the section but with underscores _ where the spaces are

Do you mean to say, that is the prescribed way of finding deep links on MoodleDocs? How about other special characters like question mark, brackets and braces, accents, etc. which come up often in section headings? Do you speak RFC1738 too?

> ( I personally tend not to link to sections as before I began contributing to docs it used to confuse me when I only saw a section of a page and not its top immediately on first access, so I don't do that deep linking very often.)

What you do is upto you. This is me looking for deep links. Mind you, I am not alone! http://www.w3.org/2001/tag/doc/deeplinking.html#background. In this particular example I was talking to somebody about http://docs.moodle.org/en/Messaging#Instant_messaging and not about http://docs.moodle.org/en/Messaging#Message_alerts. Got the idea?
In reply to Visvanath Ratnaweera

Re: [MoodleDoc] Where is the table of content?

by dawn alderson -

Visvanath, hi

following you wink

To be clear is the whole notion of using deep links, do me a favour and correct me if I am wrong will you, is that it is a direct link to the 'detail' within http web location........which saves reading reams of other stuff if not needed, can be a quick way to field the info you want-yes?   

ta

Dawn 

In reply to dawn alderson

Re: [MoodleDoc] Where is the table of content?

by Visvanath Ratnaweera -
Picture of Particularly helpful Moodlers Picture of Translators
For my purpose Yes.

As a second example, I could
a) ask you to read section 5 of http://www.w3.org/2001/tag/doc/deeplinking.html, or
b) to read http://www.w3.org/2001/tag/doc/deeplinking.html#analogy.

I am looking for b).
In reply to Visvanath Ratnaweera

Re: [MoodleDoc] Where is the table of content?

by Joseph Rézeau -
Picture of Core developers Picture of Particularly helpful Moodlers Picture of Plugin developers Picture of Testers Picture of Translators

Thanks for those interesting links, Visvanath.