[GRASS-dev] [GRASS-SVN] r62856 - in grass/trunk: lib/gis man

On Sat, Nov 22, 2014 at 7:11 AM, <svn_grass@osgeo.org> wrote:

Author: neteler
Date: 2014-11-22 04:11:07 -0800 (Sat, 22 Nov 2014)
New Revision: 62856

Modified:
   grass/trunk/lib/gis/parser_html.c
   grass/trunk/man/build_keywords.py
Log:
manual: keyword index HTML'ized

Hi, I really appreciate this improvement and I think it is great. However,
I think that the second keyword ("topic"), should also link to a keyword,
not a topic page. This would be better for consistency and would avoid
confusion.

Thanks,
Vaclav

Hi Vaclav,

please see the todo the commit…
I have a solution prepared but the python script chokes without a further modification. No time tonight to finish that…

Markus

···

On Sat, Nov 22, 2014 at 7:11 AM, <svn_grass@osgeo.org> wrote:

Author: neteler
Date: 2014-11-22 04:11:07 -0800 (Sat, 22 Nov 2014)
New Revision: 62856

Modified:
grass/trunk/lib/gis/parser_html.c
grass/trunk/man/build_keywords.py
Log:
manual: keyword index HTML’ized

Hi, I really appreciate this improvement and I think it is great. However, I think that the second keyword (“topic”), should also link to a keyword, not a topic page. This would be better for consistency and would avoid confusion.

Thanks,

Vaclav

On Sat, Nov 22, 2014 at 4:24 PM, Markus Neteler <neteler@osgeo.org> wrote:

Hi Vaclav,

please see the todo the commit...
I have a solution prepared but the python script chokes without a further
modification. No time tonight to finish that...

Sorry, I don't understand what are you trying to achieve there. I though
that links from all the keywords to keywords are the simplest option.

I suggest to treat all the keywords the same (in this list of keywords
section) and do not link topic page since it is anyway very similar to the
keyword one (although module description is a big plus).

Markus

On Nov 22, 2014 9:24 PM, "Vaclav Petras" <wenzeslaus@gmail.com> wrote:

On Sat, Nov 22, 2014 at 7:11 AM, <svn_grass@osgeo.org> wrote:

Author: neteler
Date: 2014-11-22 04:11:07 -0800 (Sat, 22 Nov 2014)
New Revision: 62856

Modified:
   grass/trunk/lib/gis/parser_html.c
   grass/trunk/man/build_keywords.py
Log:
manual: keyword index HTML'ized

Hi, I really appreciate this improvement and I think it is great.
However, I think that the second keyword ("topic"), should also link to a
keyword, not a topic page. This would be better for consistency and would
avoid confusion.

Thanks,
Vaclav

On Sat, Nov 22, 2014 at 10:52 PM, Vaclav Petras <wenzeslaus@gmail.com> wrote:

On Sat, Nov 22, 2014 at 4:24 PM, Markus Neteler <neteler@osgeo.org> wrote:

Hi Vaclav,

please see the todo the commit...
I have a solution prepared but the python script chokes without a further
modification. No time tonight to finish that...

Sorry, I don't understand what are you trying to achieve there. I though
that links from all the keywords to keywords are the simplest option.

The current implementation is as follows:
- first word: command family (raster/vector/imagery/...)
- second word: topic
- third and more word: keywords

I suggest to treat all the keywords the same (in this list of keywords
section) and do not link topic page since it is anyway very similar to the
keyword one (although module description is a big plus).

Exactly. That's why I would like to simply add the words "topic:" and
"keyword:" in front of the respective words. An example:

Old:

KEYWORDS
raster, landscape structure analysis, diversity index

New:

KEYWORDS
raster, topic: landscape structure analysis, keywords: diversity index

(ok here is only one keyword which is not enough but anyway)

Like this we have a clear distinction.
I'd like to keep the topic page as it makes more sense as only keeping
the links to the keyword page.

Just the man/build_keywords.py script needs a tweak to filter out the
words "topic:" and "keyword:" while processing the list. Will be some
simple split() change...

Markus

On Sun, Nov 23, 2014 at 10:53 AM, Markus Neteler <neteler@osgeo.org> wrote:

On Sat, Nov 22, 2014 at 10:52 PM, Vaclav Petras <wenzeslaus@gmail.com>
wrote:
> On Sat, Nov 22, 2014 at 4:24 PM, Markus Neteler <neteler@osgeo.org>
wrote:
>>
>> Hi Vaclav,
>>
>> please see the todo the commit...
>> I have a solution prepared but the python script chokes without a
further
>> modification. No time tonight to finish that...
>
> Sorry, I don't understand what are you trying to achieve there. I though
> that links from all the keywords to keywords are the simplest option.

The current implementation is as follows:
- first word: command family (raster/vector/imagery/...)
- second word: topic
- third and more word: keywords

OK, this sounds reasonable. I was referring to the state where the first

keyword was linked to the keyword. I either overlooked something or saw
some intermediate version. I like the way it is now. It is a good idea.

> I suggest to treat all the keywords the same (in this list of keywords
> section) and do not link topic page since it is anyway very similar to
the
> keyword one (although module description is a big plus).

Exactly. That's why I would like to simply add the words "topic:" and
"keyword:" in front of the respective words. An example:

Old:

KEYWORDS
raster, landscape structure analysis, diversity index

New:

KEYWORDS
raster, topic: landscape structure analysis, keywords: diversity index

I'm not sure if I like this. I think I don't. It seems to me that not

putting there "topic:" and "keywords:" is actually better. You would also
need something for command family.

Unless there is some more visually pleasing way, I would actually prefer to
have them all the same visually, although they are not the same links (but
there is a system now, I though that there was none with first keyword
different).

I think that anything eating more vertical space is not acceptable. I've
tried some other like bold or cursive but it is too much clutter.

KEYWORDS
Family: raster3d, Topic: voxel, Keywords: import, conversion, ASCII

I'm for keeping the current (here: old) state.

I know you did a lot of improvements in the keywords for individual
modules, however with r3.in.ascii I just hit two issues which we can think
about. First keyword is raster3d which fails to be linked because the
family is called raster3D. Related to that, the "in text" term is usually
"3D raster" and Soeren just changed in recent commit few 3D to 3d (I think
it should be always 3D in text).

The other issue is not so different. The second keyword (i.e. topic) is
voxel. It could make sense to have voxel in keywords since they might
contain some synonyms I believe. However, since we are using it as synonym
to 3D raster (and also volume) it makes the topic equal to family (and thus
makes topic useless). At this point I would suggest to remove voxel keyword.

http://grass.osgeo.org/grass71/manuals/r3.in.ascii.html

(ok here is only one keyword which is not enough but anyway)

Like this we have a clear distinction.
I'd like to keep the topic page as it makes more sense as only keeping
the links to the keyword page.

Just the man/build_keywords.py script needs a tweak to filter out the
words "topic:" and "keyword:" while processing the list. Will be some
simple split() change...

As I say don't bother with that. The current state is ideal, I would say.

Thanks.

Vaclav

Markus