<p dir="ltr">I will be available for updating the figures for 2.14. But I doubt I can do it in a week.</p>
<br><div class="gmail_quote"><div dir="ltr">A 19h54 Sáb, 16 de Jan de 2016, Otto Dassau <<a href="mailto:otto@qgis.org">otto@qgis.org</a>> escreveu:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hi Richard and Diethard,<br>
<br>
I have some questions about the best procedure to update the user manual.<br>
Could you please check and tell me, if I am wrong? I would prepare the<br>
following:<br>
<br>
a) Go through the "User Manual" issues and add missing issues that need to<br>
   be documented for 2.14. from changelog.<br>
   <a href="https://github.com/qgis/QGIS-Documentation/issues?q=is%3Aopen+is%3Aissue+label%3A%22User+Manual%22" rel="noreferrer" target="_blank">https://github.com/qgis/QGIS-Documentation/issues?q=is%3Aopen+is%3Aissue+label%3A%22User+Manual%22</a><br>
b) Create a list which issues should go to which chapter and make a<br>
   proposal which could be done by whom.<br>
c) Write a short documentation about updating the manual and adding it to<br>
   <a href="http://www.qgis.org/en/site/getinvolved/document.html" rel="noreferrer" target="_blank">http://www.qgis.org/en/site/getinvolved/document.html</a><br>
d) ask manual update team to create a github account, if not already done.<br>
   Allow them to write in the documentation repository. The manual updates<br>
   would take place in master branch.<br>
e) Assign issues to documenters, so they can start working based<br>
   on the latest qgis master (nightly build), now that feature freeze has<br>
   started.<br>
<br>
I plan to finish these steps within the next week, so we could start with<br>
the 4 week time period not later then 25th January. If someone can help<br>
with the preparations, it would be great.<br>
<br>
And what about the figure updates. Should we also do that before we start,<br>
so it is easier for documenters to write the manual? And would that<br>
be possible anyway within such a short time frame? Although I see the problem<br>
of duplication (only for icons, isn't it?) I would still go with the proposal<br>
from Richard.<br>
<br>
@Diethard: According to a "big bang" for the translation. I guess this will<br>
happen anyway, since we plan also to review the manual and I also guess that<br>
there will be many changes...<br>
<br>
Regards<br>
Otto<br>
<br>
Am Fri, 8 Jan 2016 18:19:02 +0100<br>
schrieb Diethard Jansen <<a href="mailto:diethard.jansen@gmail.com" target="_blank">diethard.jansen@gmail.com</a>>:<br>
<br>
> Hi Richard,<br>
><br>
> - I like the idea of having images in the source directory of screenshots<br>
> of windows/panels and being able to explain the functionality that is<br>
> included in the image. You still see options to include a translated<br>
> screenshot when you include these from images?<br>
><br>
> - I do not like the idea if this means we are going to have many duplicated<br>
> images of icons in many images directories. In that case I am in favour to<br>
> keep them defined in one single place and to include these as a<br>
> substitution. The big advantage is when the image of the icon is replaced,<br>
> you only have to replace it in one place. I am in favour of using<br>
> subsitutions for icons only!<br>
><br>
> - It may be a good idea to move the substitutions out of conf.py to<br>
> icon_substitutions.py next to conf.py and use "import icon_substitutions"<br>
> statement in conf.py. We should remove all unused icon substitions.<br>
><br>
> - Whatever is decided, please keep an eye on impact for already translated<br>
> work. Instead of a big bang where a lot of translation work has to be<br>
> restarted, I would rather opt for a gentle replacement of one technique<br>
> with the other. It can be very discouraging to translators to continue when<br>
> too much translation work has gone in one courageous action. For example,<br>
> replacing all |qg| is very easy, but the impact on translated work is<br>
> pretty big. I would replace this substition only during a rewrite of text.<br>
><br>
> Regards,<br>
> Diethard.<br>
><br>
><br>
><br>
> 2015-12-24 14:55 GMT+01:00 Richard Duivenvoorde <<a href="mailto:richard@duif.net" target="_blank">richard@duif.net</a>>:<br>
><br>
> > Hi PSC/Community,<br>
> ><br>
> > Because I think we should attract more people to write documentation for<br>
> > QGIS, I thought we should make it easier to fix/write docs.<br>
> ><br>
> > My idea: let's keep our rst framework, but do the editing/viewing in<br>
> > Github..<br>
> ><br>
> > First: look at the following two examples:<br>
> ><br>
> > [0]<br>
> ><br>
> > <a href="https://github.com/FOSS4GAcademy/GST101FOSS4GLabs/blob/master/Module%204%20Lab/QGIS%202.8/Module%204%20Lab.md" rel="noreferrer" target="_blank">https://github.com/FOSS4GAcademy/GST101FOSS4GLabs/blob/master/Module%204%20Lab/QGIS%202.8/Module%204%20Lab.md</a><br>
> ><br>
> > and<br>
> ><br>
> > [1]<br>
> ><br>
> > <a href="https://github.com/qgis/QGIS-Documentation/blob/master/source/docs/user_manual/working_with_vector/vector_properties.rst" rel="noreferrer" target="_blank">https://github.com/qgis/QGIS-Documentation/blob/master/source/docs/user_manual/working_with_vector/vector_properties.rst</a><br>
> ><br>
> > As you can see the first one is immediately readable (and more editable)<br>
> > in Github.<br>
> > We have (I think from our Latex roots) a lot of extra styling<br>
> > directives/stuff in our docs. It looks like this now:<br>
> ><br>
> > [3]<br>
> ><br>
> > <a href="http://docs.qgis.org/testing/en/docs/user_manual/working_with_vector/vector_properties.html#the-vector-properties-dialog" rel="noreferrer" target="_blank">http://docs.qgis.org/testing/en/docs/user_manual/working_with_vector/vector_properties.html#the-vector-properties-dialog</a><br>
> ><br>
> > I propose and tested the following:<br>
> ><br>
> > - move images from resources into an images directory in the source<br>
> > folder, see<br>
> > [4]<br>
> ><br>
> > <a href="https://github.com/qgis/QGIS-Documentation/tree/master_github_e/source/docs/user_manual/working_with_vector" rel="noreferrer" target="_blank">https://github.com/qgis/QGIS-Documentation/tree/master_github_e/source/docs/user_manual/working_with_vector</a><br>
> ><br>
> > - remove all the :guilabel: :menuselection: and other directives to make<br>
> > it easier to edit/view in Github<br>
> ><br>
> > - get rid of all/most of the image/icon shortcuts (needed for inline<br>
> > images) from source.conf and put them in the source file where they are<br>
> > used<br>
> ><br>
> > - remove substitutions like |qg| (for QGIS) and |nix| (for linux icon).<br>
> > It clutters the source as seen on Github.<br>
> ><br>
> > I branched docs and changed one file, look at the Github preview now:<br>
> ><br>
> > [6]<br>
> ><br>
> > <a href="https://github.com/qgis/QGIS-Documentation/blob/master_github_e/source/docs/user_manual/working_with_vector/vector_properties.rst" rel="noreferrer" target="_blank">https://github.com/qgis/QGIS-Documentation/blob/master_github_e/source/docs/user_manual/working_with_vector/vector_properties.rst</a><br>
> ><br>
> > As you can see it is the same file as the rst above [1], but here you do<br>
> > not see all the :xxxx: directives, you see the images etc. Hopefully<br>
> > much easier to add or fix a paragraph here.<br>
> ><br>
> > I did not yet move all the image substitutions but if you put those IN<br>
> > the source file and point to the local image dir, you see them also in<br>
> > Github.<br>
> ><br>
> > An example local build here next to a classic build:<br>
> > <a href="http://i.imgur.com/SjSC94N.png" rel="noreferrer" target="_blank">http://i.imgur.com/SjSC94N.png</a><br>
> ><br>
> > I also build the pdf. Because style directives like :guilabel: also are<br>
> > followed by text in `back quotes` it still gets a special styling:<br>
> > italic in pdf and 'cite' in html<br>
> > So the stuff that is now bleu in html can for example be made italic or<br>
> > bold easily.<br>
> ><br>
> > So should I make a QEP for this.<br>
> > Should I just GO?<br>
> > Do people REALLY miss the extra styling?<br>
> ><br>
> > Otto what do you think?<br>
> ><br>
> > The whole plan/vision is that by looking cleaner/better in Github, it is<br>
> > easier for people to edit/fix stuff in docs: so we have better<br>
> > Documentation!<br>
> ><br>
> > Parts of it can be automated, as nobody has recent translated images<br>
> > there is not so much work in resources directory.<br>
> > I think we should start with the User Manual first.<br>
> > Then Python Cookbook, then Training Manual..<br>
> ><br>
> > Regards,<br>
> ><br>
> > Richard Duivenvoorde<br>
> ><br>
> > PS, part 2 of all this is to fix some styling in the sphinx templates:<br>
> > remove bootstrap so hopefully it is easier to use docs in Webkit-widgets<br>
> > again (an early attempt in processing failed, I think because bootstrap<br>
> > uses to much javascript magic to make content responsive)..<br>
> ><br>
> ><br>
> > _______________________________________________<br>
> > Qgis-community-team mailing list for organizing community resources such<br>
> > as documentation, translation etc..<br>
> > <a href="mailto:Qgis-community-team@lists.osgeo.org" target="_blank">Qgis-community-team@lists.osgeo.org</a><br>
> > <a href="http://lists.osgeo.org/mailman/listinfo/qgis-community-team" rel="noreferrer" target="_blank">http://lists.osgeo.org/mailman/listinfo/qgis-community-team</a><br>
_______________________________________________<br>
Qgis-community-team mailing list for organizing community resources such as documentation, translation etc..<br>
<a href="mailto:Qgis-community-team@lists.osgeo.org" target="_blank">Qgis-community-team@lists.osgeo.org</a><br>
<a href="http://lists.osgeo.org/mailman/listinfo/qgis-community-team" rel="noreferrer" target="_blank">http://lists.osgeo.org/mailman/listinfo/qgis-community-team</a></blockquote></div><div dir="ltr">-- <br></div><div dir="ltr"><div>Alexandre Neto</div><div>---------------------</div><div>@AlexNetoGeo</div><div><a href="http://sigsemgrilhetaswordpress.com">http://sigsemgrilhetaswordpress.com</a></div><a href="http://gisunchained.wordpress.com">http://gisunchained.wordpress.com</a><br></div>