On Thu, Jul 21, 2011 at 9:49 PM, Uwe Stöhr <[email protected]> wrote:
> Am 21.07.2011 14:29, schrieb Diego Queiroz:
>
>
> As state before, I'm looking thru documentation files
>>
>
> Hi Diego,
>
> welcome on board of the documentation team!
>
>
> and I noted there are images in the documents.
>> I do have some questions about this.
>>
>> 1. How the link to the doc/clipart files should be in the file? Relative
>> to
>> the folder where the file is (eg. using "../" from "doc/pt/")? Or there is
>> some different trick?
>>
>
> The trick is to modify the files in your local SVN folder. Then the image
> paths will stay correct and relative.
> To make the documents compilable on all installation we use relative paths
> for the images. So when a file is e.g. in lib/images/math you need in your
> Portuguese file that is in lib/doc/pt to use the path "../../images/math".
> You will see if the path is correct if LyX shows the image.
>
>
> 2. Instead of using files to display colored boxes in the documentation
>> (see
>> doc/clipart/footnoteQt4.png to know what I am talking about), I decided to
>> use the ERT "\colorbox{gray_lyxbox}{\**textcolor{cyan}{foot~1}}"
>>
>
> Please use images when there are images in the English documentation files!
> If the images contain English strings, make your own screenshot. Each
> lib/doc/xx folder has therefore its own "clipart" folder.
>
> Using TeX Code is a bad idea because the docs are designed for both reading
> them in LyX and as PDF. So within LyX the user would see some weird code but
> the aim of LyX is to keep LaTeX code aways from the users if possible.
>
>
> 3. In section 2.1 of the UserGuide.lyx I can see some figures that aren't
>> what we are used to call "figures". They load the images using
>> lyx-commands
>> as argument instead of usual image files. What are these graphics?
>>
>
> They show the icons of LyX that are connected to e.g. a certain menu entry
> or feature. They are normal png images we store in lib/images.
> That they are inserted as InsetInfo has the advantage that if an icon is
> changed it will automatically be updated. So for example if the icon for the
> action "buffer-write" (saving a file) changes from a blue floppy disk to a
> red floppy disc or whatever with a different filename, you will in LyX
> always see the icon connected to the "buffer-write" action.
> InsetInfo is a special inset only for us documenters and you will see this
> inset also for menu names and shortcuts in the LyX docs.
>
> Some general notes:
>
> - please modify always the latest version of the current stable branch. So
> currently these are the files you find in our SVN branch "2_0_X".
>
> - please regularly update your SVN folder. I'm currently updating the docs
> for the last features that are new in LyX 2.0 but not yet documented.
> Especially the last days I did a lot of work and changed a lot.
>
> - if possible, translate the English docs into Portuguese without changing
> introducing further sections or changing the style or layout of the file. If
> you think that a section is missing, some info if doubled, there are
> mistakes, please inform me because all language versions must benefit from
> the changes. So also the French, Spanish, German, etc. version not only the
> Portuguese one.
>
> - if you have done some translation work and/or some new images/screenshots
> for the clipart folder please send it to me and with CC to
>
> - the maintainers of the different files are listed here:
>
> http://wiki.lyx.org/LyX/**DocumentationDevelopment#**maintain<http://wiki.lyx.org/LyX/DocumentationDevelopment#maintain>
>
>
> regards Uwe
>
Uwe. Thanks for your answers.
1. I got the idea.
2. Ok. No ERT. ;)
3. Just to know. Is there some trick to insert an InsetInfo in LyX? Or only
editing the LyX file directly?
Since I finish the work I'll follow your recomendations.
Cheers,
---
Diego Queiroz
