SEO and manuals: add viewport and page language (#2591)

This PR addresses #2589 (SEO problems on mobile devices): - Google: addresses "Page isn't usable on mobile" - "Viewport not set" - https://search.google.com/search-console/mobile-usability?resource_id=http%3A%2F%2Fgrass.osgeo.org%2F&hl=en - see: https://support.google.com/webmasters/answer/9063469#viewport_not_configured - Bing: addresses "The page is missing meta language information" - https://www.bing.com/webmasters/seoreports?siteUrl=https%3A%2F%2Fgrass.osgeo.org%2F&ruleId=39 Manual pages generated with this PR applied are validated correctly at https://validator.w3.org/
OSGeo · Oct 3, 2022 · 225a4f8 · 225a4f8
1 parent 13cdec4
commit 225a4f8
Show file tree

Hide file tree

Showing 8 changed files with 69 additions and 31 deletions.
diff --git a/REQUIREMENTS.html b/REQUIREMENTS.html
@@ -4,6 +4,8 @@
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  <title>REQUIREMENTS to compile GRASS GIS 7</title>
  <link rel="stylesheet" href="grassdocs.css" type="text/css">
+ <meta http-equiv="content-language" content="en-us">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
 </head>
 <body bgcolor="#FFFFFF">
 

diff --git a/db/drivers/mysql/grass-mesql.html b/db/drivers/mysql/grass-mesql.html
@@ -2,8 +2,10 @@
 <html>
 <head>
 <title>GRASS-MySQL embedded driver - GRASS GIS manual</title>
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<link rel="stylesheet" href="grassdocs.css" type="text/css">
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" href="grassdocs.css" type="text/css">
+ <meta http-equiv="content-language" content="en-us">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
 </head>
 <body bgcolor="white">
 

diff --git a/general/g.setproj/g.setproj.html b/general/g.setproj/g.setproj.html
@@ -2,8 +2,10 @@
 <html>
 <head>
 <title>g.setproj - GRASS GIS manual</title>
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<link rel="stylesheet" href="grassdocs.css" type="text/css">
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" href="grassdocs.css" type="text/css">
+ <meta http-equiv="content-language" content="en-us">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
 </head>
 <body bgcolor="white">
 

diff --git a/lib/gis/parser_html.c b/lib/gis/parser_html.c
@@ -1,15 +1,16 @@
+
 /*!
-  \file lib/gis/parser_html.c
-  
-  \brief GIS Library - Argument parsing functions (HTML output)
-  
-  (C) 2001-2009, 2011-2013 by the GRASS Development Team
-  
-  This program is free software under the GNU General Public License
-  (>=v2). Read the file COPYING that comes with GRASS for details.
-  
-  \author Original author CERL
-*/
+   \file lib/gis/parser_html.c
+
+   \brief GIS Library - Argument parsing functions (HTML output)
+
+   (C) 2001-2022 by the GRASS Development Team
+
+   This program is free software under the GNU General Public License
+   (>=v2). Read the file COPYING that comes with GRASS for details.
+
+   \author Original author CERL
+ */
 
 #include <stdio.h>
 #include <string.h>
@@ -45,9 +46,27 @@ void G__usage_html(void)
     fprintf(stdout, "<html>\n<head>\n");
     fprintf(stdout, "<title>%s - GRASS GIS manual</title>\n", st->pgm_name);
     fprintf(stdout,
-	    "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=iso-8859-1\">\n");
+	    " <meta http-equiv=\"Content-Type\" content=\"text/html; charset=iso-8859-1\">\n");
+    fprintf(stdout,
+            " <meta name=\"Author\" content=\"GRASS Development Team\">\n");
+    fprintf(stdout,
+            " <meta http-equiv=\"content-language\" content=\"en-us\">\n");
+    fprintf(stdout,
+            " <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">\n");
+    fprintf(stdout, " <meta name=\"description\" content=\"%s", st->pgm_name);
+    if (st->module_info.description)
+        fprintf(stdout, ": %s\">", st->module_info.description);
+    else
+        fprintf(stderr,"<%s.html> is missing the description", st->pgm_name);
+    fprintf(stdout, "\n");
+    if (st->module_info.keywords) {
+        fprintf(stdout, " <meta name=\"keywords\" content=\"");
+        G__print_keywords(stdout, NULL);
+        fprintf(stdout, "\">");
+	fprintf(stdout, "\n");
+    }
     fprintf(stdout,
-	    "<link rel=\"stylesheet\" href=\"grassdocs.css\" type=\"text/css\">\n");
+	    " <link rel=\"stylesheet\" href=\"grassdocs.css\" type=\"text/css\">\n");
     fprintf(stdout, "</head>\n");
     fprintf(stdout, "<body bgcolor=\"white\">\n");
     fprintf(stdout, "<div id=\"container\">\n\n");

diff --git a/man/build_html.py b/man/build_html.py
@@ -18,14 +18,15 @@
     "r.watershed.ram",
     "r.watershed.seg",
     "v.topo.check",
-    "helptext.html"]
+    "helptext.html",
+]
 
 # these modules don't use G_parser()
 
 desc_override = {
     "g.parser": "Provides automated parser, GUI, and help support for GRASS scipts.",
     "r.li.daemon": "Support module for r.li landscape index calculations."
-    }
+}
 
 ############################################################################
 
@@ -36,14 +37,18 @@
  <title>${title}</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  <meta name="Author" content="GRASS Development Team">
-""")
+ <meta http-equiv="content-language" content="en-us">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
+"""
+)
 
 macosx_tmpl = string.Template(\
 r"""
  <meta name="AppleTitle" content="GRASS GIS ${grass_version} Help">
  <meta name="AppleIcon" content="GRASS-${grass_mmver}/grass_icon.png">
  <meta name="robots" content="anchors">
-""")
+"""
+)
 
 header2_tmpl = string.Template(\
 r""" <link rel="stylesheet" href="grassdocs.css" type="text/css">
@@ -314,7 +319,7 @@
 
 headertopics_tmpl = \
 r"""
-<link rel="stylesheet" href="grassdocs.css" type="text/css">
+ <link rel="stylesheet" href="grassdocs.css" type="text/css">
 </head>
 <body style="width: 99%">
 <div id="container">
@@ -328,7 +333,7 @@
 
 headerkeywords_tmpl = \
 r"""
-<link rel="stylesheet" href="grassdocs.css" type="text/css">
+ <link rel="stylesheet" href="grassdocs.css" type="text/css">
 </head>
 <body style="width: 99%">
 <div id="container">

diff --git a/raster/r.li/r.li.html b/raster/r.li/r.li.html
@@ -2,8 +2,10 @@
 <html>
 <head>
 <title>r.li - GRASS GIS manual</title>
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<link rel="stylesheet" href="grassdocs.css" type="text/css">
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" href="grassdocs.css" type="text/css">
+ <meta http-equiv="content-language" content="en-us">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
 </head>
 <body bgcolor="white">
 <div id="container">

diff --git a/tools/mkhtml.py b/tools/mkhtml.py
@@ -264,9 +264,13 @@ def get_last_git_commit(src_dir, is_addon, addon_path):
 header_base = """<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <html>
 <head>
-<title>GRASS GIS Manual: ${PGM}</title>
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<link rel="stylesheet" href="grassdocs.css" type="text/css">
+ <title>GRASS GIS Manual: ${PGM}</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <meta name="Author" content="GRASS Development Team">
+ <meta name="description" content="${PGM}: ${PGM_DESC}">
+ <link rel="stylesheet" href="grassdocs.css" type="text/css">
+ <meta http-equiv="content-language" content="en-us">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
 </head>
 <body bgcolor="white">
 <div id="container">

diff --git a/tools/module_synopsis.sh b/tools/module_synopsis.sh
@@ -199,9 +199,11 @@ cat << EOF > "${TMP}.html"
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 <html>
 <head>
-<title>`g.version | cut -f1 -d'('` Command list</title>
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
-<link rel="stylesheet" href="grassdocs.css" type="text/css">
+ <title>`g.version | cut -f1 -d'('` Command list</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+ <link rel="stylesheet" href="grassdocs.css" type="text/css">
+ <meta http-equiv="content-language" content="en-us">
+ <meta name="viewport" content="width=device-width, initial-scale=1">
 </head>
 <body bgcolor="white">