Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix markdown documentation of GUI tools #5086

Merged
merged 3 commits into from
Feb 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions gui/wxpython/animation/g.gui.animation.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ follow these steps:
- choose parameter (parameter of *[m.nviz.image](m.nviz.image.md)*) to
animate (e.g. color_map)

<img src="wxGUI_animation_tool.jpg" data-border="1"
alt="Animation Tool screenshot" />
![Animation Tool screenshot](wxGUI_animation_tool.jpg)

## NOTE

Expand Down
5 changes: 2 additions & 3 deletions gui/wxpython/datacatalog/g.gui.datacatalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@ Data Catalog allows you to:
Note that projects are called *locations* at some places and in old
documentation.

<img src="datacatalog.png" data-border="0"
alt="data catalog screenshot" />
Figure: Data Catalog integrated in wxGUI.
![data catalog screenshot](datacatalog.png)
*Figure: Data Catalog integrated in wxGUI.*

## NOTES

Expand Down
6 changes: 2 additions & 4 deletions gui/wxpython/dbmgr/g.gui.dbmgr.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,12 @@ stand-alone module *g.gui.dbmgr*.
- modify vector map DB connection settings - add, remove or modify
layers.

[<img src="dbmgr_frame.png" width="600" height="401"
alt="Attribute Table Manager" />](dbmgr_frame.png)
![Attribute Table Manager](dbmgr_frame.png)
*Figure: Simple attribute filtering using Attribute Table Manager.*

### SQL Builder

[<img src="dbmgr_sql_builder.png" width="700" height="287"
alt="Attribute Table Manager and SQL Builder" />](dbmgr_sql_builder.png)
![Attribute Table Manager and SQL Builder](dbmgr_sql_builder.png)
*Figure: Attribute filtering using Attribute Table Manager and SQL
Builder.*

Expand Down
3 changes: 1 addition & 2 deletions gui/wxpython/docs/wxGUI.iscatt.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ interactivity, which allows user to:

## TOOL CONTROLS LAYOUT

<img src="wxGUI_iscatt.jpg" data-border="1"
alt="Interactive Scatter Plot Tool" />
![Interactive Scatter Plot Tool](wxGUI_iscatt.jpg)

If editing mode is activated (the green polygon tool in toolbar), the
areas which were selected in the scatter plots are highlighted. In the
Expand Down
224 changes: 115 additions & 109 deletions gui/wxpython/docs/wxGUI.md

Large diffs are not rendered by default.

22 changes: 8 additions & 14 deletions gui/wxpython/docs/wxGUI.modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ to the command representation which is used in the manuals and
tutorials. The commands can be used to call the module in the command
line, Shell scripts or, with a slight modification, in a Python script.

<img src="wxGUI_modules_parameters.png" data-border="0"
alt="r.neighbors dialog" />
![r.neighbors dialog](wxGUI_modules_parameters.png)

### Tabs

Expand All @@ -33,11 +32,9 @@ The style of the tabs can be changed through *GUI settings* -
depends on the platform and some styles might be more suitable for
different platforms.

<img src="wxGUI_modules_style_left.png" data-border="0"
alt="dialog style left" />
<img src="wxGUI_modules_style_top.png" data-border="0"
alt="dialog style top" />
Figure: Example of style "left" and "top" on Ubuntu.
![dialog style left](wxGUI_modules_style_left.png)
![dialog style top](wxGUI_modules_style_top.png)
*Figure: Example of style "left" and "top" on Ubuntu.*

### Flags

Expand All @@ -46,7 +43,7 @@ three special flags - *overwrite*, *verbose* and *quiet*. Flags
*verbose* and *quiet* set the level of verbosity of the module (how
detailed the messages should be).

<img src="wxGUI_modules_flags.png" data-border="0" alt="dialog flags" />
![dialog flags](wxGUI_modules_flags.png)

Modules which output a new map or a new file have the flag *overwrite*
which must be used when the specified output map or file is already
Expand Down Expand Up @@ -92,8 +89,7 @@ to the entry field. In case multiple maps can be specified (denoted by
*\[multiple\]* label), selecting a map from the popup list will append
the map names with comma in between.

<img src="wxGUI_modules_widget_selection.png" data-border="0"
alt="widget for selecting maps" />
![widget for selecting maps](wxGUI_modules_widget_selection.png)

If the input file is supposed to be a text file (for example color rules
in r.colors), it is possible to type the text in the provided box
Expand All @@ -104,10 +100,8 @@ so that user's workflow can be reproduced later. With *Load* button we
can display the content of selected file and edit it directly in the
box.

<img src="wxGUI_modules_widget_file1.png" data-border="0"
alt="widget for input files" />
<img src="wxGUI_modules_widget_file2.png" data-border="0"
alt="widget for input files" />
![widget for input files](wxGUI_modules_widget_file1.png)
![widget for input files](wxGUI_modules_widget_file2.png)

Figure: In the first image, user specified a full path to a file. In the
second image, user typed color rules conveniently into the box below,
Expand Down
36 changes: 15 additions & 21 deletions gui/wxpython/docs/wxGUI.nviz.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@

## DESCRIPTION

Note: **wxNviz is currently under development. Not all planned
functionality is already implemented.**

**wxNviz** is a *[wxGUI](wxGUI.md)* **3D view mode** which allows users
to realistically render multiple *surfaces* (2D raster maps) in a 3D
space, optionally using thematic coloring, draping 2D *vector* data or
Expand Down Expand Up @@ -37,16 +34,16 @@ display mode.

## 3D View Toolbar

<img src="wxGUI_nviz_toolbar.jpg" data-border="1" alt="toolbar" />
![icon](icons/script-save.png)  *Generate command for m.nviz.image*
![toolbar](wxGUI_nviz_toolbar.jpg)

![icon](icons/script-save.png)  *Generate command for m.nviz.image*:
Generate command for m.nviz.image based on current state.

![icon](icons/settings.png)  *Show 3D view mode settings*
![icon](icons/settings.png)  *Show 3D view mode settings*:
Show dialog with settings for wxGUI 3D view mode. The user settings can
be stored in wxGUI settings file.

![icon](icons/help.png)  *Show help*
![icon](icons/help.png)  *Show help*:
Show this help.

## 3D View Layer Manager Toolbox
Expand Down Expand Up @@ -78,8 +75,8 @@ panel (following label *Look:*):
- *top* moves the current eye position above the map center.
- *reset* returns all current view settings to their default values.

<img src="wxGUI_nviz_tools_view.jpg" data-border="1" alt="toolbox" />
![toolbox](wxGUI_nviz_tools_view.jpg)

You can adjust the viewer's height above the scene, perspective and
twist value to rotate the scene about the horizontal axis. An angle of 0
is flat. The scene rotates between -90 and 90 degrees.
Expand Down Expand Up @@ -158,8 +155,8 @@ In the very bottom part of the panel position of surface can be set. To
move the surface right (looking from the south) choose *X* axis and set
some positive value. To reset the surface position press *Reset* button.

<img src="wxGUI_nviz_tools_surface.jpg" data-border="1" alt="toolbox" />
![wxGUI nviz tools surface](wxGUI_nviz_tools_surface.jpg)

#### Constant surface

It is possible to add constant surface and set its properties like fine
Expand Down Expand Up @@ -202,8 +199,8 @@ Currently are implemented these markers:
Thematic mapping can be used to determine marker color and size (and
line color and width).

<img src="wxGUI_nviz_tools_vector.jpg" data-border="1" alt="toolbox" />
![wxGUI nviz tools vector](wxGUI_nviz_tools_vector.jpg)

#### 3D rasters

3D raster maps (volumes, voxel models) can be displayed either as
Expand Down Expand Up @@ -245,8 +242,8 @@ attributes.

3D rasters can be moved the same way like surfaces do.

<img src="wxGUI_nviz_tools_volume.jpg" data-border="1" alt="toolbox" />
![toolbox](wxGUI_nviz_tools_volume.jpg)

### Analysis

*Analysis* tab contains *Cutting planes* panel.
Expand Down Expand Up @@ -279,8 +276,8 @@ light color, brightness and ambient. Light position is controlled
similarly to eye position. If option *Show light model* is enabled light
model is displayed to visualize the light settings.

<img src="wxGUI_nviz_tools_light.jpg" data-border="1" alt="toolbox" />
![toolbox](wxGUI_nviz_tools_light.jpg)

The *Fringe* panel allows you to draw fringes in different directions
(North & East, South & East, South & West, North & West). It is possible
to set the fringe color and height of the bottom edge.
Expand Down Expand Up @@ -316,9 +313,6 @@ parameters, or to set the background color of the Map Display Window

## NOTE

wxNviz is under active development and distributed as "Experimental
Prototype".

Please note that with wxGTK port of wxPython (Linux systems), a problem
might appear during wxNviz initialization (nothing is rendered at all)
or when rendering vectors (bad order of rendering surfaces and vectors).
Expand Down
15 changes: 7 additions & 8 deletions gui/wxpython/docs/wxGUI.toolboxes.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Following lines can be copied to `.grass8/toolboxes/main_menu.xml` and
by removing, adding or reordering lines users can change the main menu
items. See further examples.

```sh
```xml
<?xml version="1.0" encoding="UTF-8"?>
<toolbox name="MyMainMenu">
<label>Default GRASS GIS main menu bar</label>
Expand Down Expand Up @@ -62,7 +62,7 @@ toolboxes are linked through `name` attribute.
Apart from `subtoolbox` tag, tag `toolbox` can contain individual items
(modules) and separators (for visual separation in the menu tree).

```sh
```xml
<?xml version="1.0" encoding="UTF-8"?>
<toolboxes>
<toolbox name="Raster">
Expand Down Expand Up @@ -104,7 +104,7 @@ If we are for example working only with raster data, we can hide menu
items *Vector* and *Database*. The file `main_menu.xml` then contains
the following lines where we omitted the two toolboxes:

```sh
```xml
<?xml version="1.0" encoding="UTF-8"?>
<toolbox name="CustomizedMainMenu">
<label>Default GRASS GIS main menu bar</label>
Expand All @@ -126,7 +126,7 @@ In this example we create a new toolbox *Favorites* containing existing
GRASS module and toolbox, custom module created by the user and addon
module. The `toolboxes.xml` file contains following lines:

```sh
```xml
<?xml version="1.0" encoding="UTF-8"?>
<toolboxes>
<toolbox name="MyFavorites">
Expand Down Expand Up @@ -154,7 +154,7 @@ module. The `toolboxes.xml` file contains following lines:
Optionally, we can add this toolbox to the main menu items. The
`main_menu.xml` file contains following lines:

```sh
```xml
<?xml version="1.0" encoding="UTF-8"?>
<toolbox name="CustomizedMainMenu">
<label>Default GRASS GIS main menu bar</label>
Expand All @@ -177,9 +177,8 @@ If we have `user-toolboxes-list` tag in the `main_menu.xml` file, our
custom toolbox will be listed in the automatically added *Toolboxes*
main menu item. The screenshot shows the resulting menu:

<img src="wxGUI_toolboxes.jpg" data-border="0"
alt="Toolboxes - menu customization" />

![Toolboxes - menu customization](wxGUI_toolboxes.jpg)

## NOTES

After the first start of wxGUI with custom toolboxes, `.grass/toolboxes`
Expand Down
7 changes: 3 additions & 4 deletions gui/wxpython/docs/wxGUI.vnet.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,10 @@ launched from Layer Manager menu *Vector → Network analysis → Vector
network analysis tool* or from Map Display toolbar *Analyse map → Vector
network analysis tool* ![icon](icons/vector-tools.png).

<img src="wxGUI_vnet.jpg" data-border="1"
alt="Vector Network Analysis Tool" />
Subsets for nearest centers (*[v.net.alloc](v.net.alloc.md)*)
![Vector Network Analysis Tool](wxGUI_vnet.jpg)
*Subsets for nearest centers ([v.net.alloc](v.net.alloc.md))*

*Vector Network Analysis Tool* currently allows you to:
Vector Network Analysis Tool currently allows you to:

- perform these network analyses:
- Shortest path (*[v.net.path](v.net.path.md)*)
Expand Down
Loading
Loading