Create a specific folder to export generated content to the Inkscape website

[jazzynico]

In order to ease documentation-web site synchronization, I'm going to create a specific folder in the inkscape-docs tree to store all the HTML files generated from the inkscape-docs project (tutorials, man pages, and keys and mouse references).

The same folder could be used to store the files that are not part of the website's CMS (such as architecture schema, examples, publications that come from the old site).

[jazzynico (jazzynico)]

Basic structure committed revision 515.

@Inkscape-website team - I've set up a folder in the trunk because it's convenient from the inkscape-docs' point of view. But it means you'll have to first update a complete checkout of the project and them move the content of the export-website folder.
Tell me if doing so is too tricky for the website (I can also create a separate branch with the files you need only).

[Hachmann (marenhachmann)]

I've added this to our bugs, too, now, so Martin will get an extra email.

[Martin Owens (doctormo)]

I've been thinking about having these pages be cms pages, in order to make the process more automated for people who manage the docs, I'd like to know what scripts are run to generate them and how.

Also how translations would like to be handled. Unifiying the document handling /could/ help us unify the translations too, but I'm just going to propose this as a tentative future idea; especially if we can script it.

[Hachmann (marenhachmann)]

Folder in trunk can be found here:
https://bazaar.launchpad.net/~inkscape.dev/inkscape-docs/trunk/files/head:/export-website/

Related to: https://bugs.launchpad.net/inkscape-web/+bug/1414403

[Hachmann (marenhachmann)]

Nico, can you help Martin with his question:
"I'd like to know what scripts are run to generate them and how."

[jazzynico (jazzynico)]

It's not very complex, but it requires Java and XSLT to run. Details can be found on the wiki:
http://wiki.inkscape.org/wiki/index.php/DocumentationTranslation#Tutorial_Translation

The K&M section is incomplete, but the steps are almost the same as when generating tutorials (except that we don't generate a SVG file).
For the man page, the explanation on the wiki is obsolete, and we now use PO files to generate POD files that are then converted to man pages (in Inkscape directly) and in HTML pages (in Inkscape-docs).

Maybe I should draw something so that the translation and file generation workflow is a bit more clear...

[Hachmann (marenhachmann)]

As it's working and updated now on the website, and pages are also accessible from within the Inksape program, can I assume this is now fixed? Or will further changes be needed?

[Hachmann (marenhachmann)]

Yeah, one further change is needed:
From the program, I can't access the man page at
https://inkscape.org/en/doc/man/inkscape-man.html

Inkscape opens
https://inkscape.org/doc/inkscape-man.html
 instead and gets a 404.

[Martin Owens (doctormo)]

One can browse all the docs files here:

http://bazaar.launchpad.net/~inkscape.dev/inkscape-docs-export-website/trunk/files

Be sure to open the redirects.re file which handles mapping between old and new urls.

[Martin Owens (doctormo)]

The cron job for updating the docs was disabled (during testing) I've enabled it.

[Hachmann (marenhachmann)]

Took some time to propagate, but works now.
Yay! :D

Thanks Martin and Nico for solving this together!
I'll close this now, feel free to reopen if anything is missing I don't know about.

[Hachmann (marenhachmann)]

I almost don't dare to write this, but the manpages are not accessible again...
Redirect goes to https://inkscape.org/en/doc/inkscape-man.html ...

[jazzynico (jazzynico)]

The man pages redirection looks good today.
I'm going to update the redirect.re file so that old external links to our tutorials are correctly redirected.

[Martin Owens (doctormo)]

The files need to be re-added for previous versions. Please don't link to outside websites, but keep everything on-site.

[jazzynico (jazzynico)]

> Please don't link to outside websites, but keep everything on-site.

Of course no. But existing links *from* external websites still lead to the old URL, and it would be nice to redirect them to the new tutorials (the redirect.re file is ready, but I have no commit access currently, and thus I'll probably update it later today).

[Hachmann (marenhachmann)]

@Nicolas:
When generating the files, could you add a list of links to available translations (with language names in respective language) at the top of the html pages?
(I'm not sure this would work?)

The problem is that even if a translation exists, people opening the pages from inside Inkscape will never know about them, because the link from Inkscape only goes to the English page directly (like https://inkscape.org/en/doc/inkscape-man.html).

Would you like a bug report in inkscape-docs for this?

[Hachmann (marenhachmann)]

(probably a true solution would be to redirect based on browser settings - but I'm not sure how to accomplish this with the current system)

[jazzynico (jazzynico)]

Hi Maren,

The help menu links can be translated in the UI PO files. If you change the string from po/de.po, line 34560, to "https://inkscape.org/doc/inkscape-man.de.html", using Hilfe>Kommandozeilen-Optionen will open the German version.
The same can be done for the other help menu entries.

But if you think that adding the languages list at the top of each page is still necessary, I can work on it of course.

[Hachmann (marenhachmann)]

Ah - yet another solution - and probably the best one :) Thanks, Nicolas!

I guess I can close this bug report now, the directory it's about exists and works well.