I write the user’s manual for the OSS program ‘Cherrytree’, written and maintained by Giuseppe Penone, and I’m trying to find a reliable, easy (and free) way of hosting the manual. Currently I have it in my public Dropbox folder, but that’s not the right way to go considering Dropbox is a file-hosting and not a web-hosting site. The link for that is here.
I write / update the manual entirely in Cherrytree, which has the ability to output it’s documents in HTML. That allows me to offer a Cherrytree “native” version to download for those who’d like a manual they can edit and annotate, and the HTML web version which is linked in the program’s ‘Help’ menu. Giuseppe and I really like the generated HTML version of the manual as it showcases some of what can be done with Cherrytree.
Some users have reported problems accessing the on-line manual, so I decided to try moving it to a Google Site. While that works and it’s now where the current version (0.28.1) links to, it has the drawback of having to re-create the manual in Google’s site, they don’t allow the upload of existing HTML. A lot of extra work. That link is here.
I’m trying to find a place or site that I could upload the native HTML to. I’ve done some Google searches but frankly it’s a minefield out there. I’m hoping some of the documentation writers here might have some suggestions or ideas. Any and all will be appreciated.
I write the user’s manual for the OSS program ‘Cherrytree’, written and
maintained by Giuseppe Penone, and I’m trying to find a reliable, easy
(and free) way of hosting the manual. Currently I have it in my public
Dropbox folder, but that’s not the right way to go considering Dropbox
is a file-hosting and not a web-hosting site. The link for that is
‘here’ (http://tinyurl.com/cmsadqu).
I write / update the manual entirely in Cherrytree, which has the
ability to output it’s documents in HTML. That allows me to offer a
Cherrytree “native” version to download for those who’d like a manual
they can edit and annotate, and the HTML web version which is linked in
the program’s ‘Help’ menu. Giuseppe and I really like the generated HTML
version of the manual as it showcases some of what can be done with
Cherrytree.
Some users have reported problems accessing the on-line manual, so I
decided to try moving it to a Google Site. While that works and it’s now
where the current version (0.28.1) links to, it has the drawback of
having to re-create the manual in Google’s site, they don’t allow the
upload of existing HTML. A -lot- of extra work. That link is ‘here’
(http://sites.google.com/site/cherrytreeusermanual/).
I’m trying to find a place or site that I could upload the native HTML
to. I’ve done some Google searches but frankly it’s a minefield out
there. I’m hoping some of the documentation writers here might have some
suggestions or ideas. Any and all will be appreciated.
Thanks,
Rob
Hi
Create the file as an rpm via OBS and install. You could then create a
desktop file to launch a browser.
Is it not included in the cherrytree source download?
Can’t you convert the website to a pdf?
Is the native html somewhere? eg google code.
–
Cheers Malcolm °¿° (Linux Counter #276890)
openSUSE 12.2 (x86_64) Kernel 3.4.11-2.16-desktop
up 2 days 19:51, 4 users, load average: 0.11, 0.20, 0.17
CPU Intel i5 CPU M520@2.40GHz | Intel Arrandale GPU
Hi Malcolm, sorry it took so long to respond. One of the hazards of having too many irons in the fire is I often get so sidetracked I forget about things I shouldn’t. I really need to work on organizing my on-line life!
Guiseppe and I came up with a solution that works for both of us. His brother runs the server that hosts the Cherrytree site, so he created a linked folder on the server for the manual. Now all I have to do when there’s an update is create/output it from Cherrytree and FTP it to the folder. Very easy and painless.
The main reasons we were trying to keep the native Cherrytree HTML output are: it’s easier for me to maintain, and it also acts as a good showcase for one of the abilities of the program. We had discussed packaging it with the program, but that has some drawbacks that Guiseppe really didn’t want to have to address, the biggest challenge being of course how to accommodate the different file system layouts on different OS’s. With it being web-based he only needs to provide a link that will work regardless of operating system. That seems to be the way many software programs are going with their help files. The problems really came from the fact that I’m a complete neophyte at doing such things.
Anyway, the problem is solved, and I thank you for responding to my query Malcolm. And again, I deeply apologize for taking so long to respond. Guiseppe’s brother set-up the folder for me the day after I posted this and I completely forgot about it.
I’m not sure why it shouldn’t be included in the source when they tar it up…? The html can be installed locally, and opened in the system default browser, worth an enhancement request to the maintainers?
Anyway, if you think it needs packaging up to include in openSUSE, I can push it into GNOME:Apps which will make it into the distribution.
RobtWB wrote:
> The main reasons we were trying to keep the native Cherrytree HTML
> output are: it’s easier for me to maintain, and it also acts as a good
> showcase for one of the abilities of the program. We had discussed
> packaging it with the program, but that has some drawbacks that Guiseppe
> really didn’t want to have to address, the biggest challenge being of
> course how to accommodate the different file system layouts on different
> OS’s. With it being web-based he only needs to provide a link that will
> work regardless of operating system. That seems to be the way many
> software programs are going with their help files.
I’ve noticed this trend and I think it can be a problem. Normally it’s
fine and I normally access manuals on the web rather than my stored
copies. But I’m aware there are people out there with no, slow,
unreliable, intermittent or expensive connections and they really need
to be able to download and store software and manuals when they have the
opportunity. The description fits a lot of people in less developed
countries for whom free and open software can make a major difference to
their life.
So I hope that you and other packagers of software are able to provide
downloadable documents as well as web accessible ones.
On 2012-12-13 12:13, Dave Howorth wrote:
> RobtWB wrote:
> I’ve noticed this trend and I think it can be a problem. Normally it’s
> fine and I normally access manuals on the web rather than my stored
> copies. But I’m aware there are people out there with no, slow,
> unreliable, intermittent or expensive connections and they really need
> to be able to download and store software and manuals when they have the
> opportunity. The description fits a lot of people in less developed
> countries for whom free and open software can make a major difference to
> their life.
It fits me when I’m on the move with my laptop. My ISP gives me only 500
MB/month.
Another reason I prefer local documentation to web documentation is that
it fits what I have installed. The web may describe features of the
current version, while my installed version is older and doesn’t have it.
> So I hope that you and other packagers of software are able to provide
> downloadable documents as well as web accessible ones.
Indeed.
–
Cheers / Saludos,
Carlos E. R.
(from 12.1 x86_64 “Asparagus” at Telcontar)
