wiki housekeeping

Discussions about the wiki documentation of FreeCAD and its translation.
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
Post Reply
heda
Veteran
Posts: 1348
Joined: Sat Dec 12, 2015 5:49 pm

wiki housekeeping

Post by heda »

maybe an idea to have one common thread for possible housekeeping activities on the wiki,
and split off any actual activities into their own topics as seen fit.

for example, have notice that there are pages with <div class="mw-translate-fuzzy">, not knowing, but guessing this is part of old "translation system" and should really be worked away for house keeping reasons, or?

would also like to propose that a mechanism to put pages to sleep without deleting them is put in place.
example page would be like Spreadsheet_Controller and similar.

a way of doing this could be based on the following text quoted from https://www.mediawiki.org/wiki/Help:Namespaces
"A page whose name is not prefixed by a namespace lies in the mainspace. Note, however, that colons and prefixes can also appear in page titles without indicating a namespace: the page Foo:Namespaces is a page located in the mainspace because the namespace “Foo” does not exist. Similarly the page Help:Foo:Namespaces is in the “Help” namespace. "

if a true namespace is created named legacy or depreciated, one can easily add version number for that leading to a resulting page address like Depreciated:v015:Spreadsheet_Controller in this specific case.
it appears to me that a true namespace can only be done by setting it up/reconfigure and then restarting the server..

while we are at it, why not having a custom namespace for tutorials?
or any other wild ideas for housekeeping of the wiki.

ps: the example page here in the banner has "deprecated", should it not be "depreciated"?
heda
Veteran
Posts: 1348
Joined: Sat Dec 12, 2015 5:49 pm

Re: wiki housekeeping

Post by heda »

any reason to keep templates like this around?
https://wiki.freecadweb.org/Template:Workbenches/tr
User avatar
Roy_043
Veteran
Posts: 8450
Joined: Thu Dec 27, 2018 12:28 pm

Re: wiki housekeeping

Post by Roy_043 »

heda wrote: Fri Aug 20, 2021 4:13 pm pages with <div class="mw-translate-fuzzy">
AFAIK this is used to indicate an automatic (?) translation that has to verified.

heda wrote: Fri Aug 20, 2021 4:13 pm mechanism to put pages to sleep without deleting them
This has been discussed before. IMO it would only make sense to consider this if there is an up-to-date documentation for a version that is then archived as a whole. To avoid edits the pages in the archive should all be protected. At the moment there is no up to date documentation. And it is unlikely we will reach that target when V0.20 is released.

I do not know enough about the Wiki software to talk about the impact of using namespaces. We have to keep in mind that we have limited (human) resources.

Note that there is a compiled help file available for each version. So somebody wanting to read the documentation as it existed when an older version was released can refer to that.

There are actually 3 obsolete Spreadsheet pages. I have decided to remove them. Keeping 3 loose V0.15 pages does not make sense.

heda wrote: Fri Aug 20, 2021 4:13 pm the example page here in the banner has "deprecated", should it not be "depreciated"?
Deprecated is correct.
User avatar
Roy_043
Veteran
Posts: 8450
Joined: Thu Dec 27, 2018 12:28 pm

Re: wiki housekeeping

Post by Roy_043 »

heda wrote: Fri Aug 20, 2021 7:16 pm any reason to keep templates like this around?
https://wiki.freecadweb.org/Template:Workbenches/tr
Thanks. Several of these pages were already deleted. But this one, and two more, were left behind. I have deleted them.
heda
Veteran
Posts: 1348
Joined: Sat Dec 12, 2015 5:49 pm

Re: wiki housekeeping

Post by heda »

8-) the example page was part of v0.14 release notes, so that is now a dead link, ah well

if the links to Release_notes_014 are transferred, would it be ok to kill the page?

is there any opinion regarding retiring png in favor of svg, where there are both?
User avatar
kaktus
Veteran
Posts: 1174
Joined: Sun Aug 11, 2019 11:59 am
Location: opolskie
Contact:

Re: wiki housekeeping

Post by kaktus »

.png files are periodically retired.
I read about it somewhere on the forum but now I can't point you to the reference.
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".
heda
Veteran
Posts: 1348
Joined: Sat Dec 12, 2015 5:49 pm

Re: wiki housekeeping

Post by heda »

User avatar
Roy_043
Veteran
Posts: 8450
Joined: Thu Dec 27, 2018 12:28 pm

Re: wiki housekeeping

Post by Roy_043 »

heda wrote: Sat Aug 21, 2021 6:05 pm if the links to Release_notes_014 are transferred, would it be ok to kill the page?
No. The release notes should be kept.
heda
Veteran
Posts: 1348
Joined: Sat Dec 12, 2015 5:49 pm

Re: wiki housekeeping

Post by heda »

https://wiki.freecadweb.org/Release_notes_0.14
https://wiki.freecadweb.org/Release_notes_014
no doubt that release notes should be kept, just talking about killing off the unfortunate 2nd page name, the one without the dot.
just an assumption, but anyone ending up there are getting there through internal links anyway.

edit:
checked this one a bit further, it seems like for the early versions, like 011 was used, but as of 0.18 the 0.18 page is the actual page, and 018 does not even exists.

simply propose to make the switch and retire the non-dot pages, there are not that many links to clean this up and go to a state where all release notes are with a dot (and a few further links can be tidied up, but more importantly - there is only one way it is done for the future).
Last edited by heda on Sun Aug 22, 2021 10:37 am, edited 1 time in total.
heda
Veteran
Posts: 1348
Joined: Sat Dec 12, 2015 5:49 pm

Re: wiki housekeeping

Post by heda »

Roy_43 - thanks for the flushing, and do not overwork yourself :)

noticed this one in the navigator, once that is ironed out - suppose nothing would be in the way of simply deleting the Ray_Tracing_Workbench page.
can't imagine that there are external links out there, and if there is, I would say let it be broken - the worst thing that can happen is that they see the link "Raytracing" in the navigator anyways...
left nav.png
left nav.png (7.96 KiB) Viewed 8475 times
Post Reply