kicad-developers team mailing list archive

[Wayne Stambaugh <stambaughw@xxxxxxxxxxx>]

Fabrizio,

First of all let me start by saying thank you for all you hard work updating
the documentation.  I took a quick look at getting_started_in_kicad_en.odt and
kicad_EN.odt have a few minor suggestions:

1) Change the heading color from green to black and removing the hyphen between
the number and the title would give the document a more professional appearance.

2) Perform a search and replace of all of the application names so they all
have the same capitalization.  For example kicad and Kicad should be changed to
KiCad.  I think this is correct capitalization.  However, JP is the final
authority on this.

3) The numbering in the tutorial appears to be de-dented left into the page
margin.  I think it would look better if the numbering was aligned with the
headings and the body text indented from there.

4) Change the text URLs and references to external websites (quicklib) to
hyperlinks instead of plain text.

5) An appendix (table) describing all commands along with their associated
icons, accelerators, and hot keys (as applicable) would probably be useful as well.

6) I also have mixed feelings about the toolbar icons in line with the text
instructions.  It interrupts the flow of the text.  If the appendix above was
implemented correctly, an internal document link could be used instead of the
inline icon.  This way the user could see the icon, accelerator, and hot key
all in one place.

I am willing to help as time permits but I'm not sure how effect having
multiple people working on an ODT file at the same time will be without
converting it to a flat format (FODT).  I doubt Bazaar can merge ODT file
changes which will cause problems.

Wayne

On 9/29/2011 12:25 PM, Fabrizio Tappero wrote:
> Wayne,
> no worries, whichever way you like is good for me. If you refer to the
> English proofreading just give me some time to update all documents so
> that you can read the latest docs.
> So far the docs that are more or less done for me are:
> kicad_en
> getting started in kicad
> 
> cheers
> Fabrizio
> 
> 
> On Thu, Sep 29, 2011 at 4:59 PM, Wayne Stambaugh <stambaughw@xxxxxxxxxxx> wrote:
>> On 9/29/2011 4:43 AM, fabrizio wrote:
>>> Hello,
>>> in the kicad documentation repository it looks like the file
>>> cvpcb_EN.odt is not the source of cvpcb_EN.pdf (the pdf is newer and
>>> contains already new icons). Is there anybody working on it? May I
>>> have the .odt file that has generated the cvpcb_EN.pdf in the
>>> repository.
>>>
>>> I am doing my best to slowly update all these docs. It would be great
>>> if anybody willing to help
>>> out contacts me so that we can split the work and not do things twice.
>>>
>>> It would also be great if a native English speaker could take a quick
>>> look at all 6 documents at the end of this update process.
>>
>> Fabrizio,
>>
>> I don't update my local document repo very often so you'll have to let me know
>> when you commit your changes and I will look over them.  I not sure that I have
>> commit access to the document repo on launchpad.  If I don't, is it OK to
>> comment the ODT file and mail it to you directly for you to commit?  If I have
>> commit access, I'll just commit the changes myself.
>>
>> Wayne
>>
>>
>>>
>>> thanks a lot guys
>>>
>>> Fabizio
>>> PS: is case this mail does not get to the kicad mailing list, can any
>>> of you guys forward it please.
>>>
>>> _______________________________________________
>>> Mailing list: https://launchpad.net/~kicad-developers
>>> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>>> Unsubscribe : https://launchpad.net/~kicad-developers
>>> More help   : https://help.launchpad.net/ListHelp
>>>
>>
>> _______________________________________________
>> Mailing list: https://launchpad.net/~kicad-developers
>> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>> Unsubscribe : https://launchpad.net/~kicad-developers
>> More help   : https://help.launchpad.net/ListHelp
>>
>