[GRASS-dev] [GRASS GIS] #3114: v.kriging: images in manual do not show (and when shown should be bigger)

#3114: v.kriging: images in manual do not show (and when shown should be bigger)
------------------------------+-------------------------
Reporter: mlennert | Owner: grass-dev@…
     Type: defect | Status: new
Priority: normal | Milestone: 7.0.5
Component: Addons | Version: unspecified
Keywords: v.kriging manual | CPU: Unspecified
Platform: Unspecified |
------------------------------+-------------------------
The v.kriging addon could do with a bit more love for documentation: In
the manual the images are not shown. All images as in an 'images'
directory within the addons directory, but that images directory does not
get installed together with the addon.

I don't know if there is Makefile magic to install that directory. The
other solution is to put all images into the root directory of the addon.
When doing the latter, the images appear in the manual page, but in the
version displayed within the wxGUI module window, these images are too
small (when displaying the html in a web browser, the size is smallish,
but acceptable).

Fig. 10 is not displayed because of a typo in the file name.

Finally, even though the examples are helpful, there should be more
information in the description, explaining each of the parameter's roles
and in which of the phases they are useful.

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/3114&gt;
GRASS GIS <https://grass.osgeo.org>

#3114: v.kriging: images in manual do not show (and when shown should be bigger)
--------------------------+------------------------------
  Reporter: mlennert | Owner: grass-dev@…
      Type: defect | Status: new
  Priority: normal | Milestone: 7.0.5
Component: Addons | Version: unspecified
Resolution: | Keywords: v.kriging manual
       CPU: Unspecified | Platform: Unspecified
--------------------------+------------------------------

Comment (by neteler):

Fig 10 I fixed in r69083.

Maybe worth notifying the author for the higher res pictures and fix the
rest.

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/3114#comment:1&gt;
GRASS GIS <https://grass.osgeo.org>

#3114: v.kriging: images in manual do not show (and when shown should be bigger)
--------------------------+------------------------------
  Reporter: mlennert | Owner: grass-dev@…
      Type: defect | Status: new
  Priority: normal | Milestone: 7.0.5
Component: Addons | Version: unspecified
Resolution: | Keywords: v.kriging manual
       CPU: Unspecified | Platform: Unspecified
--------------------------+------------------------------

Comment (by martinl):

Backport candidate.

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/3114#comment:2&gt;
GRASS GIS <https://grass.osgeo.org>

#3114: v.kriging: images in manual do not show (and when shown should be bigger)
--------------------------+------------------------------
  Reporter: mlennert | Owner: grass-dev@…
      Type: defect | Status: new
  Priority: normal | Milestone: 7.0.5
Component: Addons | Version: unspecified
Resolution: | Keywords: v.kriging manual
       CPU: Unspecified | Platform: Unspecified
--------------------------+------------------------------

Comment (by annakrat):

Replying to [comment:2 martinl]:
> Backport candidate.

It's an addon, so no backport.

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/3114#comment:3&gt;
GRASS GIS <https://grass.osgeo.org>

#3114: v.kriging: images in manual do not show (and when shown should be bigger)
--------------------------+------------------------------
  Reporter: mlennert | Owner: grass-dev@…
      Type: defect | Status: new
  Priority: normal | Milestone: 7.0.5
Component: Addons | Version: unspecified
Resolution: | Keywords: v.kriging manual
       CPU: Unspecified | Platform: Unspecified
--------------------------+------------------------------

Comment (by martinl):

So can we close?

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/3114#comment:4&gt;
GRASS GIS <https://grass.osgeo.org>

#3114: v.kriging: images in manual do not show (and when shown should be bigger)
--------------------------+------------------------------
  Reporter: mlennert | Owner: grass-dev@…
      Type: defect | Status: new
  Priority: normal | Milestone: 7.0.5
Component: Addons | Version: unspecified
Resolution: | Keywords: v.kriging manual
       CPU: Unspecified | Platform: Unspecified
--------------------------+------------------------------

Comment (by annakrat):

Replying to [comment:4 martinl]:
> So can we close?

No, the images are still missing.

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/3114#comment:5&gt;
GRASS GIS <https://grass.osgeo.org>

#3114: v.kriging: images in manual do not show (and when shown should be bigger)
--------------------------+------------------------------
  Reporter: mlennert | Owner: grass-dev@…
      Type: defect | Status: new
  Priority: normal | Milestone: 7.0.5
Component: Addons | Version: unspecified
Resolution: | Keywords: v.kriging manual
       CPU: Unspecified | Platform: Unspecified
--------------------------+------------------------------

Comment (by neteler):

Replying to [comment:5 annakrat]:
> No, the images are still missing.

i.e. Fig 4 + 5 + 8, etc. see

https://grass.osgeo.org/grass70/manuals/addons/v.kriging.html

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/3114#comment:6&gt;
GRASS GIS <https://grass.osgeo.org>

Dear all,

···

The v.kriging addon could do with a bit more love for documentation: In
the manual the images are not shown. All images as in an ‘images’
directory within the addons directory, but that images directory does not
get installed together with the addon.

I don’t know if there is Makefile magic to install that directory.

I have tried adding VPATH [1] to the Makefile. I would like to ask… does the issue with missing images happen just here [2] or does it appear in general? I have tried to install the modules from addons (after cleaning my GRASS) and the images seem to work correctly in my computer. I would like to understand the issue better, may I ask what is the difference between compiling module at user’s computer and here [2]?

The other solution is to put all images into the root directory of the addon.

I would prefer them to stay in separate subdirectories, but if it won’t work, I shall replace them.

When doing the latter, the images appear in the manual page, but in the
version displayed within the wxGUI module window, these images are too
small (when displaying the html in a web browser, the size is smallish,
but acceptable).

I have modified the layout, hopefully this helps.

Fig. 10 is not displayed because of a typo in the file name.

Thanks to Markus for fixing it.

Finally, even though the examples are helpful, there should be more
information in the description, explaining each of the parameter’s roles
and in which of the phases they are useful.

Thank you for the suggestion, I will add the information immediately after fixing the images.

Best regards,

Eva

[1] https://www.gnu.org/software/make/manual/html_node/General-Search.html
[2] https://grass.osgeo.org/grass70/manuals/addons/v.kriging.html

On Sun, Aug 28, 2016 at 11:08 PM, Eva Stopková <eva.stopkova@gmail.com> wrote:

Dear all,

The v.kriging addon could do with a bit more love for documentation: In
the manual the images are not shown. All images as in an 'images'
directory within the addons directory, but that images directory does not
get installed together with the addon.

I don't know if there is Makefile magic to install that directory.

I have tried adding VPATH [1] to the Makefile.

This will not work and also not necessarily portable. And image
copying is already implemented :slight_smile: and no private solution should be
implemented.

See
include/Make/HtmlRules.make

I would like to ask... does
the issue with missing images happen just here [2]

Yes.

or does it appear in general?

No

I have tried to install the modules from addons (after cleaning my
GRASS) and the images seem to work correctly in my computer. I would like to
understand the issue better, may I ask what is the difference between
compiling module at user's computer and here [2]?

If the images are at root directory of the addon nothing has to be
done in the addon Makefile and it will work on any platform.

The other solution is to put all images into the root directory of the
addon.

I would prefer them to stay in separate subdirectories, but if it won't
work, I shall replace them.

Why do you need a separate subdirectory (especially images/small/)?
Maybe a Makefile trick could be added to support a subdirectoy but two
of them are not ideal.

[...]

Best,
Markus

[1] https://www.gnu.org/software/make/manual/html_node/General-Search.html
[2] https://grass.osgeo.org/grass70/manuals/addons/v.kriging.html

#3114: v.kriging: images in manual do not show (and when shown should be bigger)
--------------------------+------------------------------
  Reporter: mlennert | Owner: grass-dev@…
      Type: defect | Status: new
  Priority: normal | Milestone: 7.0.5
Component: Addons | Version: unspecified
Resolution: | Keywords: v.kriging manual
       CPU: Unspecified | Platform: Unspecified
--------------------------+------------------------------
Changes (by neteler):

* cc: evas (added)

Comment:

At time all images are broken due to the recent r69293

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/3114#comment:7&gt;
GRASS GIS <https://grass.osgeo.org>

2016-09-11 21:51 GMT+02:00 GRASS GIS <trac@osgeo.org>:

#3114: v.kriging: images in manual do not show (and when shown should be
bigger)
--------------------------+------------------------------
  Reporter: mlennert | Owner: grass-dev@…
      Type: defect | Status: new
  Priority: normal | Milestone: 7.0.5
Component: Addons | Version: unspecified
Resolution: | Keywords: v.kriging manual
       CPU: Unspecified | Platform: Unspecified
--------------------------+------------------------------
Changes (by neteler):

* cc: evas (added)

Comment:

At time all images are broken due to the recent r69293

I have edited the manual and no images are needed anymore. May I enclose
the case studies as a pdf file to the addon directory, until a paper on
v.kriging will be prepared?

Eva

On 03/10/16 18:40, Eva Stopková wrote:

2016-09-11 21:51 GMT+02:00 GRASS GIS <trac@osgeo.org
<mailto:trac@osgeo.org>>:

    #3114: v.kriging: images in manual do not show (and when shown
    should be bigger)
    --------------------------+------------------------------
      Reporter: mlennert | Owner: grass-dev@…
          Type: defect | Status: new
      Priority: normal | Milestone: 7.0.5
     Component: Addons | Version: unspecified
    Resolution: | Keywords: v.kriging manual
           CPU: Unspecified | Platform: Unspecified
    --------------------------+------------------------------
    Changes (by neteler):

     * cc: evas (added)

    Comment:

     At time all images are broken due to the recent r69293

I have edited the manual and no images are needed anymore. May I enclose
the case studies as a pdf file to the addon directory, until a paper on
v.kriging will be prepared?

I don't think anyone ever answered this: yes, you can put the PDF in the directory. It would be very nice if you could link to it in the man page, so that "normal" user can access it. This would mean using the direct link to trac.osgeo.org/grass/...

Moritz

#3114: v.kriging: images in manual do not show (and when shown should be bigger)
--------------------------+------------------------------
  Reporter: mlennert | Owner: grass-dev@…
      Type: defect | Status: new
  Priority: normal | Milestone:
Component: Addons | Version: unspecified
Resolution: | Keywords: v.kriging manual
       CPU: Unspecified | Platform: Unspecified
--------------------------+------------------------------
Changes (by martinl):

* milestone: 7.0.7 =>

--
Ticket URL: <https://trac.osgeo.org/grass/ticket/3114#comment:10&gt;
GRASS GIS <https://grass.osgeo.org>

Thank you for the reminder; I prepared the pdf file with some case studies in 2016 [1] and I edited the manual, so no images are needed anymore. I’ve checked the link from the manual to the pdf recently, it does not work at the moment. In the next weeks, I am moving to another place, but after that I am ready to fix it. There are still several updates from 2018 [2] that I’ve done in v.kriging that should be tracked as well.

Best regards,

Eva

[1] https://trac.osgeo.org/grass/browser/grass-addons/grass7/vector/v.kriging/v.kriging.pdf
[2] https://ojs.cvut.cz/ojs/index.php/gi/article/view/gi.17.2.4

ne 28. 4. 2019 o 16:23 GRASS GIS <trac@osgeo.org> napísal(a):

#3114: v.kriging: images in manual do not show (and when shown should be bigger)
--------------------------±-----------------------------
Reporter: mlennert | Owner: grass-dev@…
Type: defect | Status: new
Priority: normal | Milestone:
Component: Addons | Version: unspecified
Resolution: | Keywords: v.kriging manual
CPU: Unspecified | Platform: Unspecified
--------------------------±-----------------------------
Changes (by martinl):

  • milestone: 7.0.7 =>


Ticket URL: <https://trac.osgeo.org/grass/ticket/3114#comment:10>
GRASS GIS <https://grass.osgeo.org>