TOCright rules?
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
Be nice to others! Respect the FreeCAD code of conduct!
TOCright rules?
What are the rules regarding TOCright? On some pages it is (almost) the first element (https://www.freecadweb.org/wiki/WikiPages). On others it comes after the first paragraph (https://www.freecadweb.org/wiki/Draft_Module). Sometimes it is in the middle of the first paragraph (https://www.freecadweb.org/wiki/Import_ ... Preference).
Re: TOCright rules?
Many pages have a:
Depending on how large the above [[Image]] and how much text is in the Description itself, I try to pintpoint where there are large gaps in whitespace to fill with the TOC. In general I aim the TOC to be right under the ==Description== outside of translation tags
So something like:
Note: we're dealing with floating objects, so it's not an exact science.
Code: Select all
==Description==
1 or
2 lines of text
[[Image:foobar.png]]
== Usage ==
So something like:
Code: Select all
==Description==
</translation>
{{TOCright}}
<translation>
1 or
2 lines of text
[[Image:foobar.png]]
== Usage ==
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
Re: TOCright rules?
There are no hard rules. I personally think that it should go to the right of the first section in a document. Normally the first section is something like an Introduction or Description, so after this first paragraph, which should be short, is a good place to put it.Roy_043 wrote: ↑Sat Feb 22, 2020 12:40 pm What are the rules regarding TOCright? On some pages it is (almost) the first element (https://www.freecadweb.org/wiki/WikiPages). On others it comes after the first paragraph (https://www.freecadweb.org/wiki/Draft_Module). Sometimes it is in the middle of the first paragraph (https://www.freecadweb.org/wiki/Import_ ... Preference).
About Draft Module and the rest of the workbench main pages, I dislike the big icon that Kunda added. It pushes the text down too much, leaving a ton of empty space. Consequently the {{TOCright}} is also too far down, which doesn't look good. I wanted users to start reading the introduction of the workbench and at the same time look at the table of contents, not stare at a giant icon.
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.
To support the documentation effort, and code development, your donation is appreciated: liberapay.com/FreeCAD.
Re: TOCright rules?
Hi.
hyymmmm
You touched on the icon that identifies the workplace.
I liked the change.
A lot of people have visual memory, and they learn how to recognize modules.
But since you've paid attention to it, so maybe it would be worth making this icon a little smaller.
It'll be a good compromise.
hyymmmm
You touched on the icon that identifies the workplace.
I liked the change.
A lot of people have visual memory, and they learn how to recognize modules.
But since you've paid attention to it, so maybe it would be worth making this icon a little smaller.
It'll be a good compromise.
Twórca polskiej wersji Wiki dla FreeCAD, współwórca polskiej wersji GUI.
"Cierpliwym być musisz, by wiedzę zgłębiać tajemną, gdyż ciemna strona mocy niszczącą i silną jest".
"Cierpliwym być musisz, by wiedzę zgłębiać tajemną, gdyż ciemna strona mocy niszczącą i silną jest".
Re: TOCright rules?
The size of the icon can be diminished, no problem. The text being pushed down is made more severe due to wiki markup newline drama coupled with the translation extension that we use, which demarcates a translation portion with an HTML comment proceeded by and followed by a new line. So we end up having tons of superfluous whitespace
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
'good first issues' | Open TODOs and FIXMEs | How to Help FreeCAD | How to report Bugs