[GRASS-dev] encoding of manual pages

GRASS GIS GRASS GIS developer
1

hallo,

manual pages displayed with g.manual do have wrong encoding, which does
not need to fit system encoding settings.

<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">

people, who are using iso-8859-2 or utf-8 will get unsuable character
encoding:

http://les-ejk.cz/tmp/Obrazovka-2.png
should be
http://les-ejk.cz/tmp/Obrazovka-3.png

because of the manual pages are generated while system compilation, I
would suggest:
    
    - generate english version of manual pages by default
    or
    - the script for manpage generation should set propper header based
      on system encoding

what do you thing?

jachym
--
Jachym Cepicky
e-mail: jachym.cepicky@centrum.cz
URL: http://les-ejk.cz
GPG: http://les-ejk.cz/gnupg_public_key/jachym_cepicky-gpg_public_key.asc
-----------------------------------------
OFFICE:
GDF-Hannover
Mengendamm 16d
30177 Hannover
Germany
e-mail: cepicky@gdf-hannover.de
URL: http://gdf-hannover.de
Tel.: +49 511-39088507

2

Jachym Cepicky wrote:

manual pages displayed with g.manual do have wrong encoding, which does
not need to fit system encoding settings.

<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">

people, who are using iso-8859-2 or utf-8 will get unsuable character
encoding:

http://les-ejk.cz/tmp/Obrazovka-2.png
should be
http://les-ejk.cz/tmp/Obrazovka-3.png

because of the manual pages are generated while system compilation, I
would suggest:
    
    - generate english version of manual pages by default
    or
    - the script for manpage generation should set propper header based
      on system encoding

what do you thing?

Generate English manual pages. All of the description.html files are
in English; it's only the portions which are auto-generated via
--html-description which will be localised.

This should be sufficient:

  diff -u -r1.9 include/Make/Html.make
  --- include/Make/Html.make 2 Jul 2006 20:28:59 -0000 1.9
  +++ include/Make/Html.make 27 Aug 2006 11:57:37 -0000
  @@ -92,7 +92,7 @@
     GISBASE=$(GISBASE) \
     PATH=$(GISBASE)/bin:$$PATH \
     $(LD_LIBRARY_PATH_VAR)="$(GISBASE)/lib:$($(LD_LIBRARY_PATH_VAR))" \
  - $(1) --html-description | grep -v '</body>\|</html>' > $(PGM).tmp.html ; true
  + LC_ALL=C $(1) --html-description | grep -v '</body>\|</html>' > $(PGM).tmp.html ; true
   
   # html rules for cmd commands
   htmlcmd: htmlcmd1 htmlgen

Alternatively, the build process could just generate an error if any
of the locale variables (LC_ALL, LC_*, LANG) are set (to something
other than "C" or "POSIX"). This would also eliminate the issue of
people including localised error messages when they report compilation
problems.

--
Glynn Clements <glynn@gclements.plus.com>

3

hallo,
On Sun, Aug 27, 2006 at 01:07:17PM +0100, Glynn Clements wrote:

Generate English manual pages. All of the description.html files are
in English; it's only the portions which are auto-generated via
--html-description which will be localised.

This should be sufficient:

  diff -u -r1.9 include/Make/Html.make
  --- include/Make/Html.make 2 Jul 2006 20:28:59 -0000 1.9
  +++ include/Make/Html.make 27 Aug 2006 11:57:37 -0000
  @@ -92,7 +92,7 @@
     GISBASE=$(GISBASE) \
     PATH=$(GISBASE)/bin:$$PATH \
     $(LD_LIBRARY_PATH_VAR)="$(GISBASE)/lib:$($(LD_LIBRARY_PATH_VAR))" \
  - $(1) --html-description | grep -v '</body>\|</html>' > $(PGM).tmp.html ; true
  + LC_ALL=C $(1) --html-description | grep -v '</body>\|</html>' > $(PGM).tmp.html ; true
   
   # html rules for cmd commands
   htmlcmd: htmlcmd1 htmlgen

+1

IMHO the HTML documentation should be english, because of the
translation of help messages does not necessary be right.

could anybody fix this in cvs? I do not have access.

Alternatively, the build process could just generate an error if any
of the locale variables (LC_ALL, LC_*, LANG) are set (to something
other than "C" or "POSIX"). This would also eliminate the issue of
people including localised error messages when they report compilation
problems.

jachym
--
Jachym Cepicky
e-mail: jachym.cepicky@centrum.cz
URL: http://les-ejk.cz
GPG: http://les-ejk.cz/gnupg_public_key/jachym_cepicky-gpg_public_key.asc
-----------------------------------------
OFFICE:
GDF-Hannover
Mengendamm 16d
30177 Hannover
Germany
e-mail: cepicky@gdf-hannover.de
URL: http://gdf-hannover.de
Tel.: +49 511-39088507

4

Jachym Cepicky wrote:

> Generate English manual pages. All of the description.html files are
> in English; it's only the portions which are auto-generated via
> --html-description which will be localised.
>
> This should be sufficient:
>
> diff -u -r1.9 include/Make/Html.make
> --- include/Make/Html.make 2 Jul 2006 20:28:59 -0000 1.9
> +++ include/Make/Html.make 27 Aug 2006 11:57:37 -0000
> @@ -92,7 +92,7 @@
> GISBASE=$(GISBASE) \
> PATH=$(GISBASE)/bin:$$PATH \
> $(LD_LIBRARY_PATH_VAR)="$(GISBASE)/lib:$($(LD_LIBRARY_PATH_VAR))" \
> - $(1) --html-description | grep -v '</body>\|</html>' > $(PGM).tmp.html ; true
> + LC_ALL=C $(1) --html-description | grep -v '</body>\|</html>' > $(PGM).tmp.html ; true
>
> # html rules for cmd commands
> htmlcmd: htmlcmd1 htmlgen

+1

IMHO the HTML documentation should be english, because of the
translation of help messages does not necessary be right.

could anybody fix this in cvs? I do not have access.

I've committed this.

--
Glynn Clements <glynn@gclements.plus.com>