FYI: Issues with Docnav variations

Discussions about the wiki documentation of FreeCAD and its translation.
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
Post Reply
User avatar
Roy_043
Veteran
Posts: 8544
Joined: Thu Dec 27, 2018 12:28 pm

FYI: Issues with Docnav variations

Post by Roy_043 »

In the past few days I have noticed several Docnav variations.

1. This is the default use and works OK:

Code: Select all

{{Docnav
|[[Import_Export_Preference|Import Export Preference]]
|[[Property_editor|Property editor]]
}}

2. I have also seen this:

Code: Select all

{{Docnav|Import Export Preference|Property editor}}
Also works. But interestingly 'previous' or 'next' are now part of the link.


3. And I have seen this:

Code: Select all

{{Docnav
|Import Export Preference
|Property editor
}}
This does not work. The template cannot handle this formatting.
vocx
Veteran
Posts: 5197
Joined: Thu Oct 18, 2018 9:18 pm

Re: FYI: Issues with Docnav variations

Post by vocx »

Roy_043 wrote: Wed May 13, 2020 7:00 pm In the past few days I have noticed several Docnav variations.
...
I think this was developed by mario52.

I personally don't like the template because it works in a linear fashion. Most pages in a wiki aren't meant to be read linearly, you need to be able to jump around the different topics. And of course, if you add a new page "between" two other pages, then it gets out of order quickly. This is bound to happen because FreeCAD is still under heavy development, including the documentation.

In my opinion, this template only makes sense in a linear manual. But most other pages in the wiki don't need it.
Always add the important information to your posts if you need help. Also see Tutorials and Video tutorials.
To support the documentation effort, and code development, your donation is appreciated: liberapay.com/FreeCAD.
User avatar
Roy_043
Veteran
Posts: 8544
Joined: Thu Dec 27, 2018 12:28 pm

Re: FYI: Issues with Docnav variations

Post by Roy_043 »

vocx wrote: Wed May 13, 2020 10:03 pm I personally don't like
The goal of this topic is more practical in nature:
Maybe the template should be fixed so that all 3 variations result in the same HTML?
And in the meantime variation #3 should not be used as it messes up the layout.
vocx
Veteran
Posts: 5197
Joined: Thu Oct 18, 2018 9:18 pm

Re: FYI: Issues with Docnav variations

Post by vocx »

Roy_043 wrote: Thu May 14, 2020 9:29 am Maybe the template should be fixed so that all 3 variations result in the same HTML?
There is a million different ways you can use this template. See its code in https://wiki.freecadweb.org/Template:Docnav

I don't feel like spending time fixing any problems with this template. Ask mario.
Always add the important information to your posts if you need help. Also see Tutorials and Video tutorials.
To support the documentation effort, and code development, your donation is appreciated: liberapay.com/FreeCAD.
User avatar
Roy_043
Veteran
Posts: 8544
Joined: Thu Dec 27, 2018 12:28 pm

Re: FYI: Issues with Docnav variations

Post by Roy_043 »

I see that the faulty variation #3 is actually the first example on the linked page. Something must have broken.
mario52 wrote: Ping
mario52
Veteran
Posts: 4692
Joined: Wed May 16, 2012 2:13 pm

Re: FYI: Issues with Docnav variations

Post by mario52 »

hi

the example in the template page work well !!

Code: Select all

{{Docnav
|Draft Workbench 
|Arch Workbench 
}}


he is preferable to use this model ([[Import_Export_Preference|Import Export Preference]]) many easy for the translator
Roy_043 wrote: Wed May 13, 2020 7:00 pm 1. This is the default use and works OK:

Code : Tout sélectionner

{{Docnav
|[[Import_Export_Preference|Import Export Preference]]
|[[Property_editor|Property editor]]
}}
_________________________________________________________________________________________________________________

certain new translator make this (example)

Code: Select all

{{Docnav/fr
|Draft Workbench/fr 
|Arch Workbench/fr 
}}
instead

Code: Select all

{{Docnav/fr
|[[Draft Workbench/fr|atelier Draft]]
|[[Arch Workbench/fr|atelier Arch]] 
}}
please the link to the page you work for see...

mario
Maybe you need a special feature, go into Macros_recipes and Code_snippets, Topological_data_scripting.
My macros on Gist.github here complete macros Wiki and forum.
User avatar
Roy_043
Veteran
Posts: 8544
Joined: Thu Dec 27, 2018 12:28 pm

Re: FYI: Issues with Docnav variations

Post by Roy_043 »

Attachments
Docnav_issue.png
Docnav_issue.png (59.72 KiB) Viewed 597 times
User avatar
Roy_043
Veteran
Posts: 8544
Joined: Thu Dec 27, 2018 12:28 pm

Re: FYI: Issues with Docnav variations

Post by Roy_043 »

Issue #2:
Compare:
https://wiki.freecadweb.org/Introduction_to_Python (next/previous not part of link).
https://wiki.freecadweb.org/Scripted_objects (next/previous part of link).
mario52
Veteran
Posts: 4692
Joined: Wed May 16, 2012 2:13 pm

Re: FYI: Issues with Docnav variations

Post by mario52 »

hi

i modify the documentation to adapt the vertical docnav

mario
Maybe you need a special feature, go into Macros_recipes and Code_snippets, Topological_data_scripting.
My macros on Gist.github here complete macros Wiki and forum.
User avatar
Roy_043
Veteran
Posts: 8544
Joined: Thu Dec 27, 2018 12:28 pm

Re: FYI: Issues with Docnav variations

Post by Roy_043 »

OK, thanks.
Post Reply