wiki housekeeping

Discussions about the wiki documentation of FreeCAD and its translation.
User avatar
kaktus
Posts: 719
Joined: Sun Aug 11, 2019 11:59 am
Location: opolskie
Contact:

Re: wiki housekeeping

Post by kaktus »

Gentlemen new topic, the bar has gone up. :roll:

https://crowdin.com/translate/freecad-a ... pl#6582166

The link I provided contains a Wiki page reference in the translation string.

Of course every translator can modify it to his own language version ... but this is not what I wanted to point out.

If you change the name of the page in any way, the link in the program will be dead :!:

Below is the content for those who do not have an account on the Crowdin platform, but are interested in the topic.
The BIM workbench also has a <a href="https://wiki.freecadweb.org/BIM_Workben ... t;complete documentation</a> available under the Help menu. The "what's this?" button will also open the help page of any tool from the toolbars.
let this be just an example ...
:idea:
wierny padawan mistrza arturromarr
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".
User avatar
Roy_043
Veteran
Posts: 5243
Joined: Thu Dec 27, 2018 12:28 pm

Re: wiki housekeeping

Post by Roy_043 »

Not exactly a housekeeping issue, but yes there are more such cases. F.e. the links in the Help menu. It is not very likely that the BIM_Workbench page will be renamed, but if that happens redirects will of course be created so that old links still work.

Or are you proposing a different solution?
User avatar
kaktus
Posts: 719
Joined: Sun Aug 11, 2019 11:59 am
Location: opolskie
Contact:

Re: wiki housekeeping

Post by kaktus »

Well, I have no idea how to solve it.

But I wanted to bring this to your attention.

The strings in Crowdin contain links to various pages, that one is just an example...
wierny padawan mistrza arturromarr
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
Posts: 993
Joined: Sat Dec 12, 2015 5:49 pm

Re: wiki housekeeping

Post by heda »

https://wiki.freecadweb.org/Special:DoubleRedirects
there is one for "Exposing C++ to Python/ru"
appears to require renaming/deletion of pages to fix it

broken redirects have some as well...
https://wiki.freecadweb.org/Special:BrokenRedirects

btw, it would be nice if there was a graphic template instead of just small font text link on the new features...

current
Screenshot from 2022-06-12 10-28-57.png
Screenshot from 2022-06-12 10-28-57.png (5.74 KiB) Viewed 393 times
nicer
Screenshot from 2022-06-12 10-28-57 2.png
Screenshot from 2022-06-12 10-28-57 2.png (7.94 KiB) Viewed 393 times
as idea, someone would obviously need to do a nice svg (the one i did is of course useless, artistry is not my cup of tea...)
User avatar
Roy_043
Veteran
Posts: 5243
Joined: Thu Dec 27, 2018 12:28 pm

Re: wiki housekeeping

Post by Roy_043 »

Thanks. The double redirect was fixed. The pages with the broken redirects were not used and have been deleted.

Regarding the suggested template:
I don't know if it is wise to introduce new templates. Right now they don't survive when the Wiki is converted to GitHub. Markdown does not seem to support them?

Compare:
Draft_Line
https://github.com/FreeCAD/FreeCAD-docu ... ft_Line.md
heda
Posts: 993
Joined: Sat Dec 12, 2015 5:49 pm

Re: wiki housekeeping

Post by heda »

cool, on the tidying

what, is wiki about to become gh-wiki?
or it is just a mirror...?
User avatar
kaktus
Posts: 719
Joined: Sun Aug 11, 2019 11:59 am
Location: opolskie
Contact:

Re: wiki housekeeping

Post by kaktus »

wierny padawan mistrza arturromarr
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".
User avatar
Roy_043
Veteran
Posts: 5243
Joined: Thu Dec 27, 2018 12:28 pm

Re: wiki housekeeping

Post by Roy_043 »

heda wrote: Sun Jun 12, 2022 9:59 am what, is wiki about to become gh-wiki?
Yup, that seems to be the plan.
heda
Posts: 993
Joined: Sat Dec 12, 2015 5:49 pm

Re: wiki housekeeping

Post by heda »

learned 2 things about the wiki...

a) the wiki is smart enough to do diffs on complete copy/paste - cool, that means that one can just copy a complete page into any editor with highlight for wiki, do the edits there (much more pleasant than doing them in the browser), paste the whole thing and the wiki takes care of the actual diff, sweet!!


b) one has to wait a long time for seeing the update of an image when performing an "upload new version" to replace the image, it just did not show to begin with...

however it seems like some cache is now updated, and it somehow worked...

anyhow https://wiki.freecadweb.org/File:Macro_ ... _form1.png can be deleted now.

while we are at it, do not see any use for 16x16 png icons...
https://wiki.freecadweb.org/File:ArchDesign.png
https://wiki.freecadweb.org/File:PartDesign.png
https://wiki.freecadweb.org/File:Ship.png
https://wiki.freecadweb.org/File:Complete.png
https://wiki.freecadweb.org/File:Freecad-doc.png
https://wiki.freecadweb.org/File:Web.png
https://wiki.freecadweb.org/File:Blank.png
https://wiki.freecadweb.org/File:Workbe ... racing.png
https://wiki.freecadweb.org/File:Mesh.png

or odd pixel sizes for that matter...
https://wiki.freecadweb.org/File:Workbe ... eering.png
https://wiki.freecadweb.org/File:Workbench_Points.png
https://wiki.freecadweb.org/File:Workbench_Test.png
https://wiki.freecadweb.org/File:FEM_Co ... locity.png
https://wiki.freecadweb.org/File:Curves ... dCurve.svg
https://wiki.freecadweb.org/File:FreeCA ... ltiple.png

or an unused windows logo...
https://wiki.freecadweb.org/File:Window ... e_2012.svg

some of these pics have links, so if no objections, i will work those links away and then someone can do the wipe on that list...

ps: it turned out to be 3 things, one about the forum mark-up as well, the links render as links although they do not have any markup on them - did not know that before... (or maybe i did and forgot about it :-))
Post Reply