[GRASS-dev] Unifing naming of 3D rasters

Hi,

I’ve tried to unify usage of “3D raster (map)” in the most visible parts of documentation and interface, namely 3D raster intro, 3D view and menu (and module tree).

There are few things missing. For example, keyword link is dead because it goes to “raster3d.html” but the family page is “raster3D.html”. All occurrences of “raster3D”, including the one in PyGRASS, should be probably replaced by “raster3d” or another appropriate form (3D raster or raster_3d).

Also in toolboxes, the names of toolboxes still contain volume, this should be just find and replace but I cannot test it properly tonight, so changed just the user visible strings. (Note that XML attribute value cannot start with number.)

There is a lot of different terminology in documentation of modules and then there is also v.vol.rst module but this one might be the exception.

Please see the commits for details. Proof reading welcome.

Vaclav

http://trac.osgeo.org/grass/changeset/64055
http://trac.osgeo.org/grass/changeset/64054
http://trac.osgeo.org/grass/changeset/64053
http://trac.osgeo.org/grass/ticket/2409

On Sun, Jan 11, 2015 at 6:05 AM, Vaclav Petras <wenzeslaus@gmail.com> wrote:

Hi,

I've tried to unify usage of "3D raster (map)" in the most visible parts of
documentation and interface, namely 3D raster intro, 3D view and menu (and
module tree).

There are few things missing. For example, keyword link is dead because it
goes to "raster3d.html" but the family page is "raster3D.html". All
occurrences of "raster3D", including the one in PyGRASS, should be probably
replaced by "raster3d" or another appropriate form (3D raster or raster_3d).

I suppose it should all become "raster_3d" for consistency.

Markus

On Sun, Jan 11, 2015 at 3:13 PM, Markus Neteler <neteler@osgeo.org> wrote:

> There are few things missing. For example, keyword link is dead because
it
> goes to "raster3d.html" but the family page is "raster3D.html". All
> occurrences of "raster3D", including the one in PyGRASS, should be
probably
> replaced by "raster3d" or another appropriate form (3D raster or
raster_3d).

I suppose it should all become "raster_3d" for consistency.

I fixed the keyword link and unified the titles with "3D raster" in r64109.
I used "raster3d" because this is the keyword used in the modules. If there
is a will to change it to "raster_3d" it should be enough just to pick
proper places from r64109 for the build part, titles are now handled
separately, so this should be easier too. I fixed only HTML, hopefully man
but not reStructuredText.

I would change PyGRASS package/module name to "raster3d" the underscores
are allowed for modules, if it improves readability (not sure if our case
qualifies), and discouraged for packages.

http://trac.osgeo.org/grass/changeset/64109
https://www.python.org/dev/peps/pep-0008/#package-and-module-names

On Tue, Jan 13, 2015 at 3:45 AM, Vaclav Petras <wenzeslaus@gmail.com> wrote:

I fixed the keyword link and unified the titles with "3D raster" in r64109.

Excellent. I re-generated the manuals on the Web site, now at a first
glance no more broken links.

I used "raster3d" because this is the keyword used in the modules. If there
is a will to change it to "raster_3d" it should be enough just to pick
proper places from r64109 for the build part, titles are now handled
separately, so this should be easier too. I fixed only HTML, hopefully man
but not reStructuredText.

I think "raster3d" looks good.

I would change PyGRASS package/module name to "raster3d" the underscores are
allowed for modules, if it improves readability (not sure if our case
qualifies), and discouraged for packages.

http://trac.osgeo.org/grass/changeset/64109
https://www.python.org/dev/peps/pep-0008/#package-and-module-names

Will you backport it? For tomorrow RC1 is scheduled.

thanks
Markus

Hi,

2015-01-13 12:25 GMT+01:00 Markus Neteler <neteler@osgeo.org>:

Will you backport it? For tomorrow RC1 is scheduled.

I vote for backport. Martin

--
Martin Landa
http://geo.fsv.cvut.cz/gwiki/Landa
http://gismentors.eu/mentors/landa

On Tue, Jan 13, 2015 at 2:17 PM, Martin Landa <landa.martin@gmail.com>
wrote:

Hi,

2015-01-13 12:25 GMT+01:00 Markus Neteler <neteler@osgeo.org>:

> Will you backport it? For tomorrow RC1 is scheduled.

I will backport all these changes in the evening, I was just waiting in

case there would be some additional changes.

I should probably change PyGRASS too, I just hope that I will not break
anything.

I vote for backport. Martin

--
Martin Landa
http://geo.fsv.cvut.cz/gwiki/Landa
http://gismentors.eu/mentors/landa

On Tue, Jan 13, 2015 at 2:23 PM, Vaclav Petras <wenzeslaus@gmail.com> wrote:

On Tue, Jan 13, 2015 at 2:17 PM, Martin Landa <landa.martin@gmail.com>
wrote:

Hi,

2015-01-13 12:25 GMT+01:00 Markus Neteler <neteler@osgeo.org>:

> Will you backport it? For tomorrow RC1 is scheduled.

I will backport all these changes in the evening, I was just waiting in

case there would be some additional changes.

Done.

http://trac.osgeo.org/grass/changeset/64155

I should probably change PyGRASS too, I just hope that I will not break
anything.

Done using raster3d which is used all over lib/python where lowercase is
appropriate.

http://trac.osgeo.org/grass/changeset/64154

I vote for backport. Martin

--
Martin Landa
http://geo.fsv.cvut.cz/gwiki/Landa
http://gismentors.eu/mentors/landa

n Sun, Jan 11, 2015 at 12:05 AM, Vaclav Petras <wenzeslaus@gmail.com> wrote:

I've tried to unify usage of "3D raster (map)" in the most visible parts
of documentation and interface, namely 3D raster intro, 3D view and menu
(and module tree).

I was not able to change text in the "layout" image. As the README says,

"the source file r3_volume_layout.xcf is probably broken." What about some
older versions? Is there some scriptable way to redo the image? Perhaps
using matplotlib? I hope we will be able to do it at least for 7.1.

Vaclav

http://grass.osgeo.org/grass71/manuals/r3_volume_layout.png
http://grass.osgeo.org/grass71/manuals/raster3dintro.html

There is a lot of different terminology in documentation of modules and

then there is also v.vol.rst module but this one might be the exception.

Please see the commits for details. Proof reading welcome.

Vaclav

http://trac.osgeo.org/grass/changeset/64055
http://trac.osgeo.org/grass/changeset/64054
http://trac.osgeo.org/grass/changeset/64053
http://trac.osgeo.org/grass/ticket/2409

On Tue, Jan 20, 2015 at 9:56 PM, Vaclav Petras <wenzeslaus@gmail.com> wrote:

I was not able to change text in the "layout" image. As the README says,
"the source file r3_volume_layout.xcf is probably broken." What about some
older versions?

I have replaced it in SVN by downloading the older version (with same
content as far as I can see):
http://trac.osgeo.org/grass/browser/grass/trunk/lib/raster3d/g3d_volume_layout.xcf?rev=47531

Now it is at least no longer corrupted.

Is there some scriptable way to redo the image? Perhaps
using matplotlib? I hope we will be able to do it at least for 7.1.

Soeren may know...

Markus

Vaclav

http://grass.osgeo.org/grass71/manuals/r3_volume_layout.png
http://grass.osgeo.org/grass71/manuals/raster3dintro.html

On Tue, Jan 20, 2015 at 4:05 PM, Markus Neteler <neteler@osgeo.org> wrote:

On Tue, Jan 20, 2015 at 9:56 PM, Vaclav Petras <wenzeslaus@gmail.com>
wrote:
> I was not able to change text in the "layout" image. As the README says,
> "the source file r3_volume_layout.xcf is probably broken." What about
some
> older versions?

I have replaced it in SVN by downloading the older version (with same
content as far as I can see):

http://trac.osgeo.org/grass/browser/grass/trunk/lib/raster3d/g3d_volume_layout.xcf?rev=47531

Now it is at least no longer corrupted.

I changed the image in GIMP and did all the related changes in 64270.

http://trac.osgeo.org/grass/changeset/64270

> Is there some scriptable way to redo the image? Perhaps
> using matplotlib? I hope we will be able to do it at least for 7.1.

Soeren may know...

Not much need now since you found the working version, however it would be

still useful to be able to create the image in some simple way (although
learning Paraview might generally useful).

Markus

> Vaclav
>
> http://grass.osgeo.org/grass71/manuals/r3_volume_layout.png
> http://grass.osgeo.org/grass71/manuals/raster3dintro.html