Skip to content

Commit

Permalink
docs: add Intro: Graphical User Interface (OSGeo#4746)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
neteler authored Nov 23, 2024
1 parent 6c45ad9 commit bea8435
Show file tree
Hide file tree
Showing 14 changed files with 102 additions and 3 deletions.
1 change: 1 addition & 0 deletions db/databaseintro.html
Original file line number Diff line number Diff line change
Expand Up @@ -101,4 +101,5 @@ <h3>See also</h3>
<li><a href="imageryintro.html">Introduction into image processing</a></li>
<li><a href="temporalintro.html">Introduction into temporal data processing</a></li>
<li><a href="projectionintro.html">Projections and spatial transformations</a></li>
<li><a href="wxguiintro.html">Graphical User Interface</a></li>
</ul>
1 change: 1 addition & 0 deletions doc/projectionintro.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,5 @@ <h3>See also</h3>
<li><a href="imageryintro.html">Introduction into image processing</a></li>
<li><a href="temporalintro.html">Introduction into temporal data processing</a></li>
<li><a href="databaseintro.html">Database management</a></li>
<li><a href="wxguiintro.html">Graphical User Interface</a></li>
</ul>
6 changes: 5 additions & 1 deletion gui/Makefile
Original file line number Diff line number Diff line change
@@ -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
75 changes: 75 additions & 0 deletions gui/wxguiintro.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<!-- meta page description: wxGUI in GRASS GIS -->
<!-- meta page index: wxgui -->

<h3>Introduction to the GRASS GIS Graphical User Interface</h3>

<h4>Overview</h4>

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.

<h4>Features</h4>

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

<ul>
<li>A clean and customizable layout for efficient workspace management.</li>
<li>Integrated support for both raster and vector data operations.</li>
<li>Drag-and-drop capabilities for quick layer addition and arrangement.</li>
<li>Support for live previews of data and processing results.</li>
<li>Direct access to GRASS GIS modules, complete with user-friendly
dialog windows.</li>
<li>Advanced debugging and scripting capabilities for developers and
power users.</li>
</ul>

<h4>Getting Started</h4>

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 <a href="wxGUI.html">here</a>.

New GRASS GIS users can explore the integrated help system or visit the
<a href="https://grass.osgeo.org/documentation/">GRASS GIS documentation</a>
for tutorials and guides.

<h4>Key Components</h4>

The wxGUI is composed of several modules and features:

<ul>
<li><strong>Map Display</strong>: Visualize raster, vector, and 3D data
layers in an interactive map viewer.</li>
<li><strong>Layer Manager</strong>: Organize and control the visibility,
styling, and properties of your data layers.</li>
<li><strong>Data Catalog</strong>: Explore and manage GRASS GIS mapsets
and spatial data with ease.</li>
<li><strong>Geoprocessing Tools</strong>: Access a wide range of geospatial
analysis and modeling tools through an easy-to-use interface.</li>
<li><strong>Command Console</strong>: Run GRASS GIS commands directly,
with syntax highlighting and autocompletion support.</li>
<li><strong>3D View</strong>: Analyze and visualize 3D landscapes
using NVIZ.</li>
</ul>

The wxGUI components are explained in greater detail
<a href="wxGUI.components.html">here</a>.

<h3>See also</h3>

<ul>
<li><a href="rasterintro.html">Introduction to raster data processing</a></li>
<li><a href="raster3dintro.html">Introduction to 3D raster data (voxel) processing</a></li>
<li><a href="imageryintro.html">Introduction to image processing</a></li>
<li><a href="temporalintro.html">Introduction into temporal data processing</a></li>
<li><a href="databaseintro.html">Introduction to database management</a></li>
<li><a href="projectionintro.html">Projections and spatial transformations</a></li>
</ul>
2 changes: 1 addition & 1 deletion gui/wxpython/docs/wxGUI.html
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,7 @@ <h2>SEE ALSO</h2>

<em>
<a href="wxGUI.components.html">wxGUI components</a><br>
<a href="wxGUI.modules.html">wxGUI module dialogs</a>
<a href="wxGUI.modules.html">wxGUI module dialogs</a><br>
<a href="wxGUI.toolboxes.html">wxGUI toolboxes (menu customization)</a>
</em>

Expand Down
1 change: 1 addition & 0 deletions imagery/imageryintro.html
Original file line number Diff line number Diff line change
Expand Up @@ -293,4 +293,5 @@ <h3>See also</h3>
<li><a href="temporalintro.html">Introduction into temporal data processing</a></li>
<li><a href="databaseintro.html">Database management</a></li>
<li><a href="projectionintro.html">Projections and spatial transformations</a></li>
<li><a href="wxguiintro.html">Graphical User Interface</a></li>
</ul>
3 changes: 2 additions & 1 deletion man/build_html.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@
</td>
<td width="33%" valign="top" class="box"><h3>&nbsp;Graphical User Interface</h3>
<ul>
<li class="box"><span><a href="wxGUI.html">wxGUI</a></span></li>
<li class="box"><a href="wxguiintro.html">Intro: Graphical User Interface</a></li>
<li class="box"><span><a href="wxGUI.html">wxGUI details</a></span></li>
<li class="box"><a href="wxGUI.components.html">wxGUI components</a></li>
<li class="box"><a href="wxGUI.toolboxes.html">wxGUI toolboxes</a></li>
</ul>
Expand Down
1 change: 1 addition & 0 deletions man/build_md.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@
</td>
<td width="33%" valign="top" class="box"><h3>&nbsp;Graphical User Interface</h3>
<ul>
<li class="box"><a href="wxguiintro.html">Intro: Graphical User Interface</a></li>
<li class="box"><span><a href="wxGUI.html">wxGUI</a></span></li>
<li class="box"><a href="wxGUI.components.html">wxGUI components</a></li>
<li class="box"><a href="wxGUI.toolboxes.html">wxGUI toolboxes</a></li>
Expand Down
1 change: 1 addition & 0 deletions man/build_rest.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@
Intro vector map processing and network analysis <vectorintro>
Intro database management <databaseintro>
Intro temporal data processing <temporalintro>
Intro Graphical User Interface <wxguiintro>
Display/Graphical User Interfaces
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
1 change: 1 addition & 0 deletions man/mkdocs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ plugins:
- glightbox
use_directory_urls: false
nav:
- GUI: wxGUI.md
- Startup: grass.md
- Databases: database.md
- Display: display.md
Expand Down
1 change: 1 addition & 0 deletions raster/rasterintro.html
Original file line number Diff line number Diff line change
Expand Up @@ -361,4 +361,5 @@ <h3>See also</h3>
<li><a href="temporalintro.html">Introduction into temporal data processing</a></li>
<li><a href="databaseintro.html">Database management</a></li>
<li><a href="projectionintro.html">Projections and spatial transformations</a></li>
<li><a href="wxguiintro.html">Graphical User Interface</a></li>
</ul>
1 change: 1 addition & 0 deletions raster3d/raster3dintro.html
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,7 @@ <h3>See also</h3>
<li><a href="imageryintro.html">Introduction into image processing</a></li>
<li><a href="temporalintro.html">Introduction into temporal data processing</a></li>
<li><a href="projectionintro.html">Projections and spatial transformations</a></li>
<li><a href="wxguiintro.html">Graphical User Interface</a></li>
<li><a href="wxGUI.nviz.html">wxGUI 3D View Mode</a></li>
<li><em><a href="m.nviz.image.html">m.nviz.image</a></em></li>
</ul>
10 changes: 10 additions & 0 deletions temporal/temporalintro.html
Original file line number Diff line number Diff line change
Expand Up @@ -281,3 +281,13 @@ <h4>See also</h4>

<li> <a href="http://www.geostat-course.org/Topic_Gebbert">GEOSTAT 2012 GRASS Course</a></li>
</ul>

<ul>
<li><a href="rasterintro.html">Introduction into raster data processing</a></li>
<li><a href="raster3dintro.html">Introduction into 3D raster data (voxel) processing</a></li>
<li><a href="vectorintro.html">Introduction into vector data processing</a></li>
<li><a href="imageryintro.html">Introduction into image processing</a></li>
<li><a href="databaseintro.html">Database management</a></li>
<li><a href="projectionintro.html">Projections and spatial transformations</a></li>
<li><a href="wxguiintro.html">Graphical User Interface</a></li>
</ul>
1 change: 1 addition & 0 deletions vector/vectorintro.html
Original file line number Diff line number Diff line change
Expand Up @@ -394,4 +394,5 @@ <h3>See also</h3>
<li><a href="temporalintro.html">Introduction into temporal data processing</a></li>
<li><a href="databaseintro.html">Introduction to database management</a></li>
<li><a href="projectionintro.html">Projections and spatial transformations</a></li>
<li><a href="wxguiintro.html">Graphical User Interface</a></li>
</ul>

0 comments on commit bea8435

Please sign in to comment.