From bea8435a9e84b0e9789cac03aaa5bb9d619194c9 Mon Sep 17 00:00:00 2001 From: Markus Neteler Date: Sat, 23 Nov 2024 22:10:42 +0100 Subject: [PATCH] docs: add Intro: Graphical User Interface (#4746) While the Graphical User Interface is important, it lacked an own "landing page" which also appears in the markdown sidebar. This PR adds a wxGUI introduction page. --- db/databaseintro.html | 1 + doc/projectionintro.html | 1 + gui/Makefile | 6 ++- gui/wxguiintro.html | 75 ++++++++++++++++++++++++++++++++++++ gui/wxpython/docs/wxGUI.html | 2 +- imagery/imageryintro.html | 1 + man/build_html.py | 3 +- man/build_md.py | 1 + man/build_rest.py | 1 + man/mkdocs/mkdocs.yml | 1 + raster/rasterintro.html | 1 + raster3d/raster3dintro.html | 1 + temporal/temporalintro.html | 10 +++++ vector/vectorintro.html | 1 + 14 files changed, 102 insertions(+), 3 deletions(-) create mode 100644 gui/wxguiintro.html diff --git a/db/databaseintro.html b/db/databaseintro.html index ef7d34791b5..3569dd34983 100644 --- a/db/databaseintro.html +++ b/db/databaseintro.html @@ -101,4 +101,5 @@

See also

  • Introduction into image processing
  • Introduction into temporal data processing
  • Projections and spatial transformations
    • +
  • Graphical User Interface
    • diff --git a/doc/projectionintro.html b/doc/projectionintro.html index f85416640d3..3998d367453 100644 --- a/doc/projectionintro.html +++ b/doc/projectionintro.html @@ -76,4 +76,5 @@

    See also

  • Introduction into image processing
  • Introduction into temporal data processing
  • Database management
    • +
  • Graphical User Interface
    • diff --git a/gui/Makefile b/gui/Makefile index 3f7a063fb02..30102feb257 100644 --- a/gui/Makefile +++ b/gui/Makefile @@ -1,7 +1,11 @@ MODULE_TOPDIR = .. +PGM = wxguiintro + SUBDIRS = icons images scripts xml wxpython include $(MODULE_TOPDIR)/include/Make/Dir.make -default: parsubdirs +default: htmldir + +htmldir: parsubdirs diff --git a/gui/wxguiintro.html b/gui/wxguiintro.html new file mode 100644 index 00000000000..0ba40cd4084 --- /dev/null +++ b/gui/wxguiintro.html @@ -0,0 +1,75 @@ + + + +

    Introduction to the GRASS GIS Graphical User Interface

    + +

    Overview

    + +The wxGUI (wxPython-based Graphical User Interface) is the primary user +interface for GRASS GIS. Designed for efficiency and ease of use, the +wxGUI provides an intuitive way to interact with spatial data and the +powerful tools available in GRASS GIS. + +The GUI supports the visualisation of spatial data, the execution of +geoprocessing tasks or the management of complex workflows and offers a +comprehensive set of tools. + +

    Features

    + +The wxGUI is designed to cater to both novice and advanced users with +the following features: + + + +

    Getting Started

    + +To launch the wxGUI, simply start GRASS GIS. Upon startup, the wxGUI will +load, providing access to its various components. + +The wxGUI usage is explained in greater detail here. + +New GRASS GIS users can explore the integrated help system or visit the +GRASS GIS documentation +for tutorials and guides. + +

    Key Components

    + +The wxGUI is composed of several modules and features: + + + +The wxGUI components are explained in greater detail +here. + +

    See also

    + + diff --git a/gui/wxpython/docs/wxGUI.html b/gui/wxpython/docs/wxGUI.html index 1c92004e4d3..ebf4680e6eb 100644 --- a/gui/wxpython/docs/wxGUI.html +++ b/gui/wxpython/docs/wxGUI.html @@ -693,7 +693,7 @@

    SEE ALSO

    wxGUI components
    - wxGUI module dialogs + wxGUI module dialogs
    wxGUI toolboxes (menu customization)     diff --git a/imagery/imageryintro.html b/imagery/imageryintro.html index c0ef2a48616..69a189be758 100644 --- a/imagery/imageryintro.html +++ b/imagery/imageryintro.html @@ -293,4 +293,5 @@

    See also

  • Introduction into temporal data processing
  • Database management
  • Projections and spatial transformations
    • +
  • Graphical User Interface
    • diff --git a/man/build_html.py b/man/build_html.py index 08596bb169c..8116c8fccc5 100644 --- a/man/build_html.py +++ b/man/build_html.py @@ -80,7 +80,8 @@

     Graphical User Interface

    diff --git a/man/build_md.py b/man/build_md.py index 0aae069edef..73cb222521c 100644 --- a/man/build_md.py +++ b/man/build_md.py @@ -66,6 +66,7 @@

     Graphical User Interface

    diff --git a/raster3d/raster3dintro.html b/raster3d/raster3dintro.html index b51748b4dd8..1e45022227c 100644 --- a/raster3d/raster3dintro.html +++ b/raster3d/raster3dintro.html @@ -203,6 +203,7 @@

    See also

  • Introduction into image processing
  • Introduction into temporal data processing
  • Projections and spatial transformations
    • +
  • Graphical User Interface
  • wxGUI 3D View Mode
  • m.nviz.image
    • diff --git a/temporal/temporalintro.html b/temporal/temporalintro.html index 2780efd8c85..e63dbf32c87 100644 --- a/temporal/temporalintro.html +++ b/temporal/temporalintro.html @@ -281,3 +281,13 @@

    See also

  • GEOSTAT 2012 GRASS Course
    • + + diff --git a/vector/vectorintro.html b/vector/vectorintro.html index db85a0afd37..f19b9507f0d 100644 --- a/vector/vectorintro.html +++ b/vector/vectorintro.html @@ -394,4 +394,5 @@

    See also

  • Introduction into temporal data processing
  • Introduction to database management
  • Projections and spatial transformations
    • +
  • Graphical User Interface