Fwd: [Frescobaldi] Re: export the user guide to HTML (issue 825)

Am Mittwoch, 30. Januar 2019 07:23:45 UTC+1 schrieb Federico Bruni:

Hi folks

As you know, the current user guide for Frescobaldi 3 is available only
within the application. Exporting it to HTML is a long standing issue
(at least since 2016):
<https://github.com/frescobaldi/frescobaldi/issues/825>

There's anybody who's willing to work on it? :-)
It would be great to get this done in the next future, as I'm working
on the new website for Frescobaldi and it would be good to be able to
include the HTML user manual.

You don't have to be acquainted with Frescobaldi code base - Urs told
me. Here's what he wrote to me:

> When displaying a page in the user guide Frescobaldi converts the
> Markdown file to HTML and then loads that in the text browser widget.
> So it should be *fairly* straightforward to write a harvesting tool
> that does that for the whole structure - it's basically about
> *managing*, not about doing the basic work.
> It should be equally possible to implement that within Frescobaldi
> ("Export User Guide") or as a standalone tool. The latter would look
> more natural to me while the former might be easier to do.

<https://github.com/frescobaldi/frescobaldi/tree/master/frescobaldi_app/userguide>

Any volunteer?

Let me just add that this would be a great way to support Frescobaldi development with a medium-commitment contribution ;-)

Urs

Thanks
Federico

PS
The website I'm working on is generated with Hugo from Markdown sources.
In theory I may add above userguide as a git submodule in a content
directory and let Hugo convert it to HTML. This would work if the user
guide files were simple Markdown, but they contain variables and other
stuff which only Frescobaldi scripts can understand.

From:	Urs Liska
Subject:	Fwd: [Frescobaldi] Re: export the user guide to HTML (issue 825)
Date:	Wed, 30 Jan 2019 08:35:31 +0100
User-agent:	Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.4.0