[Qgis-community-team] Proposal to divide some pages in QGIS documentation

[DelazJ]

Hi,
Richard,


2015-06-07 20:31 GMT+02:00 Richard Duivenvoorde <richard at duif.net>:

>
> Hi,
>
> it's a good thing, to split up and make docs better \o/
>
> one thing to note, is that this will also mean (partly) new resources in
> transifex. The synchronisation between the sources/files in github and
> transifex is still by hand. So please let me know when you want a
> 'synchronisation/update'.
>
> another thing to know/note is that if we create a new file (and we add
> it as a resource), it is automatically pushed to transifex, BUT old (not
> nessecary) files will NOT be removed automatically.
>


Even if the PR is merged in master, it'll be pushed to Transifex?
I thought only released doc (2.8) was available to translation. Or do you
suggest to backport this PR?


> so please let us/me know if you find a resource at transifex, of which
> you cannot find a file in the documentation website anymore. We should
> then remove the resource.
> BUT we have to be carefull with removing, because removing a 'resource'
> will also remove all translations. And I'm not sure (yet) that from a
> removed resource we keep th 'translation memory' to be able to use for
> (the same) strings in newer or renamed resources.
>
>
IMO, this point is very important as it will be regrettable to lose the
translations already done, especially on a so vast chapter.
I found this link (http://docs.transifex.com/faq/#source-files) but I can't
tell if this sentence (*"However, old translations are kept in the
project's Translation Memory
<http://docs.transifex.com/guides/localization#translation-memory-tm>")* is
just about translations done in an updated resource file or about all
translations that have been saved in the project one day.


> ( just a heads up, so you all know how things work, and we can refine
> and make translations better :-)  )
>
> Regards,
>
> Richard Duivenvoorde
>

Thanks for your heads-up
Regards,
Harrissou


> On 07-06-15 16:16, Yves Jacolin wrote:
> > Le samedi 6 juin 2015, 01:22:26 DelazJ a écrit :
> >> Hi Folks,
> >>
> >> While reading QGIS documentation, there are some pages that leave me
> >> puzzled. You may have a look at Print Composer [1], vector properties
> >> dialog [2] pages.
> >> IMHO, these pages are too long. For the reader, scrolling can become
> >> tedious while looking for a precise information. Sure, the subject is
> wide
> >> and there is a lot of informations at these pages but I think that,
> because
> >> subject is wide, it can be splited into several pages, shorter, more
> >> precise and readable. As there are Previous/Next buttons, skipping
> sections
> >> while reading can easily be done.
> >> From writer side, I think that having short (and specialized) page
> helps us
> >> to quickly identify where there may be a lack of documentation, easily
> >> update or improve them...
> >>
> >> So, few days ago, I made a pull request [3] that splits Print Composer
> >> chapter into many pages, reorganizing sections and sequences.
> >>
> >> If you agree with the spliting principle of these chapters, can some
> >> documentation writers review it, amend it and let me know if it is ok?
> It's
> >> the first time I use rst files so it'd be nice if someone can review my
> PR
> >> before I begin spliting vector properties chapter.
> >>
> >> Regards,
> >> Harrissou
> >>
> >> [1]
> >>
> http://docs.qgis.org/2.8/fr/docs/user_manual/print_composer/print_composer.h
> >> tml [2]
> >>
> http://docs.qgis.org/2.8/fr/docs/user_manual/working_with_vector/vector_prop
> >> erties.html [3] https://github.com/qgis/QGIS-Documentation/pull/544/
> > DelazJ,
> >
> > My opinions is that your split is perfect. As you said all in one page
> should
> > be too much and the split is great.
> >
> > One more feedback (with my comments in you Pr): the index page contains
> only a
> > toc, do you think we can add a small paragraph to introduce the composer
> > chapter? As the one in "First Steps" section for instance?
> >
> > Otherwise just merge.
> >
> > Y.
> >
>
> _______________________________________________
> Qgis-community-team mailing list for organizing community resources such
> as documentation, translation etc..
> Qgis-community-team at lists.osgeo.org
> http://lists.osgeo.org/mailman/listinfo/qgis-community-team
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-community-team/attachments/20150608/9f31fd01/attachment.html>