← Back to team overview

kicad-developers team mailing list archive

Re: Embedded Documentation

 

Dick Hollenbeck a écrit :

wafeliron wrote:
> Hello there developers,
> I like the content of the documentation but needs to be more
> proffesionalised and found a way to do that. wxWidgets ships a sample
> class to show chm like documentation. There is then no need to have
> other programs installed pdf readers / webbrowser / openoffice. I
> bought a HelpBlocks license to help you guys out. If i have the kicad
> part done i will show.
>
> If you look for the sample look in wx2.8-samples/ samples/help/
>
> Greets,
> Jerry
>

The move to PDF was recent. Obviously somebody thought it was a good
idea.

Users do not need to have Open Office installed. Any one else
complaining about installing Open Office is probably a whiner any way.
Open Office is free, it works great, and exports to PDF great.

This is ** exactly ** the reason i use now the pdf format for on line help files.
The previous format was html.
Create the files from Open Office source files. was a very tedious task (hours of work to create, zip and test all the files).
Create pdf files is very easy with Open Office.

No need for a webbrowser? Can't say that this has been bothering me
since about 1994.

So I do not share your enthusiasm for this solution.

What needs to be done is enhance the content, not the delivery mechanism
in my opinion.


This is also my opinion.

The help text has lots of room for improvement, and Open
Office was designed to edit text.

Dick


--

Jean-Pierre CHARRAS

Maître de conférences
Directeur d'études 2ieme année.
Génie Electrique et Informatique Industrielle 2
Institut Universitaire de Technologie 1 de Grenoble
BP 67, 38402 St Martin d'Heres Cedex

Recherche :
GIPSA-LIS - INPG
46, Avenue Félix Viallet
38031 Grenoble cedex








References