[Optionally] Collapse the User Manual Main Index

The main index of the User Manual has grown so large, that when you scroll down you easily loose orientation.
To make the index more clear, it would be fine if the index was collapsed on “chapter” level.
Searching the MediaWiki documentation, there are different ways to make content collapsible/expandable, but it looks like when lists is made with markdown (#, ##, ### etc), it is not possible at the same time to collapse lines.

One way would be to rewrite the index using html tags with ‘mw-collapsible’ and ‘mw-collapsed’ in '<div>' and using <ol></ol> to create numbered list. But that would remove the simplicity of the markdown lists.

I have also seen {{collapse}} mentioned as a built-in template, but if I try to use that, I get non-existing template. Same also for {{collapse top}} and {{collapse buttom}}, which are also mentioned in the MediaWiki documentation.

Any ideas of how we can make the main index more readable and useful?

Claus

Hi, Thanks for your edits :slight_smile:

I’ve already started making a script that is based on the pdf generation one by @GaryGriffin , that will automate making this index page and for English and for other languages it will relie on the English titles with the two letter language code , which is why I’ve not been updating the index recently as doing it manually is too tedious.

One of the benefits of the existing index is that you can typically search on words from the interface and things you can do with Gramps that makes it very useful, so I disagree with collapsing it as that would stop inpage searching unless you expand those sections as I’ve tested this format with wikipedia already!

Once I’ve updated the remaining screenshots for English and cleared the stub’s I’ll update the English index in the current format and then later on we can revisit the formatting of the page while trying to keep the existing simplicity of the format, like using different size fonts for the different level and bolding them along with shading between section etc, I have a few trials I was testing on local mediawiki install.

Also some housekeeping note that it is polite to respond and acknowledge other peoples questions on your talk page of the wiki in case you have not seen the page as so that you are coordinating with the rest of us please…

3 Likes

It might be possible to create another user selectable theme. And have it contain CSS that makes TOC enties collapsible.

Or just make specific levels collapse.

The mobile theme already collapses a lot of the content.

I agree, don’t collapse the index.

@Gioto Thanks for the many many updates and improvements you have made to the user manual.

3 Likes

I also prefer the Index fully expanded. (Which is why I switch to the desktop theme even when on mobile devices.

But there would be no harm in adding another custom theme for those who prefer collapsed. (Or just collapse anything after the top 2 levels.) Perhaps @csam would like to experiment with customizing the CSS of his preferred theme and then contribute it to Gramps project.

@Gioto ‘s reply mentions the harm is inpage searching will not work. I use the index in the same way.

What I’m not opposed to is having the page default to be fully expanded with options to collapse sections as needed, but that will take a bit more work with new templates, @gioto can you consider this later on with your script please, and thanks for the edits everyone :sunny:

3 Likes

Ok, will add it to my list, Thanks

3 Likes

I have an updated script for 6.0 if desired. It is just a few tweaks, mostly in the non-English versions.

3 Likes

I uploaded the PDF generation scripts for 6.0 at https://gramps-project.org/wiki/index.php/File:UserManual60.zip . To run you will have to have your IP whitelisted to avoid Captcha block.

3 Likes

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.