No TOC available ?

Discussions about the wiki documentation of FreeCAD and its translation.
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
User avatar
r-frank
Veteran
Posts: 2180
Joined: Thu Jan 24, 2013 6:26 pm
Location: Möckmühl, Germany
Contact:

No TOC available ?

Post by r-frank »

Hello.

Since once up-to-date, the list of available external workbenches will be quite long so i was wondering
a) if we schould keep any sort order on this page (for example alphabetically) ?
b) why there is no TOC available. We do have Headlines, so where is the TOC (i hope you know what i mean, the "navigation menu"
on the side in an extra frame ...

Thanks for looking into this.

Roland
Deutsche FreeCAD Tutorials auf Youtube
My GrabCAD FreeCAD-Projects
FreeCAD lessons for beginners in english

Native german speaker - so apologies for my english, no offense intended :)
User avatar
NormandC
Veteran
Posts: 18589
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Re: No TOC available ?

Post by NormandC »

Hi Roland,

The TOC is automatically generated once there are 4 headers. Add a 4th workbench, you'll see.
User avatar
r-frank
Veteran
Posts: 2180
Joined: Thu Jan 24, 2013 6:26 pm
Location: Möckmühl, Germany
Contact:

Re: No TOC available ?

Post by r-frank »

Hello.

Now that's what i call insider informations ... :D

Thanks Normand.

Roland
Deutsche FreeCAD Tutorials auf Youtube
My GrabCAD FreeCAD-Projects
FreeCAD lessons for beginners in english

Native german speaker - so apologies for my english, no offense intended :)
renatorivo
Veteran
Posts: 2611
Joined: Tue Feb 21, 2012 8:07 pm
Location: Torino - Italy

Re: No TOC available ?

Post by renatorivo »

Hi Roland,
since you seem interested in developing the page External_workbenches, and I started the page Template:DevWorkbenches and those linked, perhaps we can merge these pages on a single page.

My ad in the wiki viewtopic.php?f=21&t=15876

You may freely use my Sandbox as you like, if you feel that there are useful things

Renato
User avatar
r-frank
Veteran
Posts: 2180
Joined: Thu Jan 24, 2013 6:26 pm
Location: Möckmühl, Germany
Contact:

Re: No TOC available ?

Post by r-frank »

Hello Renato.

Yes, now that you mention it, good idea.
I think External workbenches can serve as a quick overview with data about what the workbench is good for, the author, github site, forum discussion and links to documentation ...

Since i added the two chapters about external workbenches and macros on the user hub page i think that i will be able to invest some time in the upcoming weekend to enhance the pages ...

I am also planning to do (first german voiced) tutorial(s) about the animation workbench.
I already did one german voiced about the assembly2-workbench.

I am also planning to do englisch versions but one step at a time ... :D

Roland
Deutsche FreeCAD Tutorials auf Youtube
My GrabCAD FreeCAD-Projects
FreeCAD lessons for beginners in english

Native german speaker - so apologies for my english, no offense intended :)
User avatar
NormandC
Veteran
Posts: 18589
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Re: No TOC available ?

Post by NormandC »

Hello,
r-frank wrote:a) if we schould keep any sort order on this page (for example alphabetically) ?
Or by type, like the Macros recipe page? For example, BOLTS and Fasteners have similar purposes. But I think alphabetical sorting would be good to start with.

I just thought of something concerning the FreeCAD Plugin Installer done by Mandeep. It is currently lacking a GUI, but when it gets added, it would be useful to get a description and a screenshot for a module before installing it. I wonder if the wiki page could serve this purpose, with the GUI extracting the info from the wiki? Or more simply giving a link.
User avatar
r-frank
Veteran
Posts: 2180
Joined: Thu Jan 24, 2013 6:26 pm
Location: Möckmühl, Germany
Contact:

Re: No TOC available ?

Post by r-frank »

NormandC wrote:I just thought of something concerning the FreeCAD Plugin Installer done by Mandeep. It is currently lacking a GUI, but when it gets added, it would be useful to get a description and a screenshot for a module before installing it. I wonder if the wiki page could serve this purpose, with the GUI extracting the info from the wiki? Or more simply giving a link.
Good Idea, Normand.
I will see how i can proceed with the enhancements of the External workbenches page.
Maybe i will open an issue on the github page of the plugin installer ...

Roland
Deutsche FreeCAD Tutorials auf Youtube
My GrabCAD FreeCAD-Projects
FreeCAD lessons for beginners in english

Native german speaker - so apologies for my english, no offense intended :)
renatorivo
Veteran
Posts: 2611
Joined: Tue Feb 21, 2012 8:07 pm
Location: Torino - Italy

Re: No TOC available ?

Post by renatorivo »

NormandC wrote:Hello,

r-frank wrote:
a) if we schould keep any sort order on this page (for example alphabetically) ?


Or by type, like the Macros recipe page? For example, BOLTS and Fasteners have similar purposes. But I think alphabetical sorting would be good to start with.
here Template:DevWorkbenches
in sortable wikitable form. It can be rearranged at will.
User avatar
r-frank
Veteran
Posts: 2180
Joined: Thu Jan 24, 2013 6:26 pm
Location: Möckmühl, Germany
Contact:

Re: No TOC available ?

Post by r-frank »

Hello renato.

I have started some work on the wiki for the drawing dimensioning workbench on Github, see here.

Unluckily there is no chance to have translations of those pages on Github the easy way.

But integrating 22 pages (or even more) in the FreeCAD-Wiki seems to be no good choice.
I'll have to think about that more intense ...

Roland
Deutsche FreeCAD Tutorials auf Youtube
My GrabCAD FreeCAD-Projects
FreeCAD lessons for beginners in english

Native german speaker - so apologies for my english, no offense intended :)
renatorivo
Veteran
Posts: 2611
Joined: Tue Feb 21, 2012 8:07 pm
Location: Torino - Italy

Re: No TOC available ?

Post by renatorivo »

r-frank wrote:I have started some work on the wiki for the drawing dimensioning workbench on Github
Thanks Roland
r-frank wrote:But integrating 22 pages (or even more) in the FreeCAD-Wiki seems to be no good choice.
the presentation page of the Workbench, and then the pages for commands, this is the standard

Renato
Post Reply