Skip to content

Commit

Permalink
Style database update added (#8949)
Browse files Browse the repository at this point in the history
  • Loading branch information
DelazJ authored Mar 8, 2024
2 parents 9a1e636 + 0010fa5 commit 31e48ce
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 32 deletions.
38 changes: 38 additions & 0 deletions docs/user_manual/introduction/qgis_configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1835,6 +1835,9 @@ Under |symbology| :guilabel:`Styles` tab, you can configure symbols and colors
inherent to the project, allowing to safely share the project among different
machines.

Default symbols
...............

The :guilabel:`Default Symbols` group lets you control how new layers will
be drawn in the project when they do not have an existing :file:`.qml` style
defined. You can set :guilabel:`Marker`, :guilabel:`Line`, :guilabel:`Fill` to
Expand All @@ -1843,6 +1846,9 @@ Ramp` and :guilabel:`Text Format` (e.g. when enabling labeling).
Any of these items can be reset using the :guilabel:`Clear` entry from
the corresponding drop-down widget.

Options
.......

In the :guilabel:`Options` group, you can:

* Apply a default :guilabel:`Opacity` to new layers
Expand All @@ -1858,6 +1864,9 @@ In the :guilabel:`Options` group, you can:

.. _project_colors:

Project Colors
..............

There is also an additional section where you can define specific colors for the
running project. Like the :ref:`global colors <colors_options>`, you can:

Expand Down Expand Up @@ -1890,6 +1899,33 @@ These colors are identified as :guilabel:`Project colors` and listed as part of
#. Update the project color once and the change is reflected EVERYWHERE
it's in use.

.. _style_database:

Style Database
..............

A style database in QGIS is a structured repository designed to store symbols,
text formats, and other styling elements. It serves as a centralized location
where you can organize and manage your symbology resources efficiently.
You can create a dedicated style database for a specific client, housing
symbols tailored to that client's need. This ensures a clean and organized
approach, without cluttering the default style database.
In multi-user environments, it's possible to store project-specific styles
in a shared location. By linking a project to these styles, all users within
the project gain access to common symbology, eliminating the need for
manual import or updates to individual local style database.
Storing symbols in a project file offers a practical solution, preventing users
from overcrowding their global style database with project-specific symbology.
This approach guarantees that other users working on the same project immediately
have access to all the necessary symbology upon loading the project.

In the :guilabel:`Style Database` section you can choose to
|symbologyAdd| :guilabel:`Add` or |symbologyRemove| :guilabel:`Remove`
style database or you can |newPage| :guilabel:`Create new style database`.
When you add or remove a style database in this section, the changes will
be automatically reflected in the |symbology| :guilabel:`Symbology Properties`.


.. _project_data_source_properties:

Data Sources Properties
Expand Down Expand Up @@ -2687,6 +2723,8 @@ in the QGIS user profile.
:width: 1.5em
.. |measureBearing| image:: /static/common/mActionMeasureBearing.png
:width: 1.5em
.. |newPage| image:: /static/common/mActionNewPage.png
:width: 1.5em
.. |nix| image:: /static/common/nix.png
:width: 1em
.. |offsetCurve| image:: /static/common/mActionOffsetCurve.png
Expand Down
73 changes: 43 additions & 30 deletions docs/user_manual/style_library/style_manager.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,36 +49,17 @@ You can open that modeless dialog either:
Organizing style items
----------------------

The :guilabel:`Style Manager` dialog displays in its center a frame with
previewed items organized into tabs:

* :guilabel:`All` for a complete collection of point, linear and surface symbols
and label settings as well as predefined color ramps and text formats;
* |pointLayer| :guilabel:`Marker` for point symbols only;
* |lineLayer| :guilabel:`Line` for linear symbols only;
* |polygonLayer| :guilabel:`Fill` for surface symbols only;
* |color| :guilabel:`Color ramp`;
* |text| :guilabel:`Text format` to manage :ref:`text formats <text_format>`,
which store the font, color, buffers, shadows, and backgrounds of texts
(i.e. all the formatting parts of the label settings, which for instance can
be used in layouts);
* |labelingSingle| :guilabel:`Label settings` to manage :ref:`label settings
<showlabels>`, which include the text formats and some layer-type specific
settings such as label placement, priority, callouts, rendering...
* |legend| :guilabel:`Legend Patch Shapes` to manage custom legend patch
shapes, which include :guilabel:`Marker`, :guilabel:`Line` and
:guilabel:`Fill` geometries.
* |3d| :guilabel:`3D Symbols` to configure symbols with :ref:`3D properties
<3dsymbols>` (extrusion, shading, altitude, ...) for the features to render
in a :ref:`3D Map view <label_3dmapview>`

You can arrange the Styles in |iconView| :guilabel:`Icon View` or in
|openTable| :guilabel:`List View` on the bottom right side. In both views
the tooltip shows a larger instance of the style.
The thumbnail size slider at the left of the icons helps you adjust the actual
thumbnail sizes in the dialog, for a better preview of the symbols!

For each family of items, you can organize the elements into different categories,
In the upper left corner of the :guilabel:`Style Manager` dialog, within
the drop-down menu, you can choose the style database you want to connect to.
If you choose :guilabel:`Default` you will be connected to the default style database
where you can find all available default style items and the ones that you saved in this database.
Choosing :guilabel:`Project Styles` will connect you to the Project Style database
where you can find only symbols that you saved in this database.
If you created more style databases, they will be listed in the drop-down menu.
There are also options to |symbologyAdd| :sup:`Add existing style database to project`
and |newPage| :sup:`Create new style database` (see more :ref:`Style database <style_database>`).

For each style database, you can organize the elements into different categories,
listed in the panel on the left:

* **Favorites**: displayed by default when configuring an item, it shows an
Expand Down Expand Up @@ -126,6 +107,36 @@ To remove a tag or a smart group, right-click on it and select the |symbologyRem
:guilabel:`Remove` button. Note that this does not delete the items grouped in the
category.

The :guilabel:`Style Manager` dialog displays in its center a frame with
previewed items organized into tabs:

* :guilabel:`All` for a complete collection of point, linear and surface symbols
and label settings as well as predefined color ramps and text formats;
* |pointLayer| :guilabel:`Marker` for point symbols only;
* |lineLayer| :guilabel:`Line` for linear symbols only;
* |polygonLayer| :guilabel:`Fill` for surface symbols only;
* |color| :guilabel:`Color ramp`;
* |text| :guilabel:`Text format` to manage :ref:`text formats <text_format>`,
which store the font, color, buffers, shadows, and backgrounds of texts
(i.e. all the formatting parts of the label settings, which for instance can
be used in layouts);
* |labelingSingle| :guilabel:`Label settings` to manage :ref:`label settings
<showlabels>`, which include the text formats and some layer-type specific
settings such as label placement, priority, callouts, rendering...
* |legend| :guilabel:`Legend Patch Shapes` to manage custom legend patch
shapes, which include :guilabel:`Marker`, :guilabel:`Line` and
:guilabel:`Fill` geometries.
* |3d| :guilabel:`3D Symbols` to configure symbols with :ref:`3D properties
<3dsymbols>` (extrusion, shading, altitude, ...) for the features to render
in a :ref:`3D Map view <label_3dmapview>`

You can arrange the Styles in |iconView| :guilabel:`Icon View` or in
|openTable| :guilabel:`List View` on the bottom right side. In both views
the tooltip shows a larger instance of the style.
The thumbnail size slider at the left of the icons helps you adjust the actual
thumbnail sizes in the dialog, for a better preview of the symbols!


Adding, editing or removing an item
-----------------------------------

Expand Down Expand Up @@ -412,6 +423,8 @@ back to the :guilabel:`New Legend Patch Shape` dialog to keep creating new shape
:width: 1.2em
.. |lineLayer| image:: /static/common/mIconLineLayer.png
:width: 1.5em
.. |newPage| image:: /static/common/mActionNewPage.png
:width: 1.5em
.. |openTable| image:: /static/common/mActionOpenTable.png
:width: 1.5em
.. |pointLayer| image:: /static/common/mIconPointLayer.png
Expand Down
6 changes: 4 additions & 2 deletions docs/user_manual/style_library/symbol_selector.rst
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,10 @@ You can setup some parameters that apply to the global symbol:
|openTable| :sup:`List View` button below the frame;
* or as icon preview using the |iconView| :sup:`Icon View` button.

* Press the :guilabel:`Save Symbol` button to add the symbol being edited to the
symbols library.
* Press the :guilabel:`Save Symbol` button to open the :guilabel:`Save New Symbol` dialog.
Here, you can choose the :guilabel:`Destination` where you want to add the symbol being edited,
give it a :guilabel:`Name` and add :guilabel:`Tag(s)`.
You also have the option to |checkbox| :sup:`Add to favorites` your new symbol.
* With the :guilabel:`Advanced` |selectString| option, you can:

* for line and fill symbols, :guilabel:`Clip features to canvas extent`.
Expand Down

0 comments on commit 31e48ce

Please sign in to comment.