Add "Create categorized renderer from styles" algorithm #2988

DelazJ · 2018-09-11T02:42:04Z

yjacolin · 2018-09-11T10:51:21Z

source/docs/user_manual/processing_algs/qgis/cartography.rst

+The specified expression (or field name) is used to create categories for the
+renderer. A category will be created for each unique value within the layer.
+Each category is individually matched to the symbols which exist within
+the specified QGIS XML style database. Whenever a matching symbol name is found,


Does "XML" word is important for the final user?

Maybe to say that SLD does not work? Or maybe PG saved style?
For reference, I copy pasted almost the GUI

PG saved style is in XML :)

Right 😄 Remains the SLD based style that is not supported.

Again, please don't call the style a database... QGIS styles XML file?

Note that, for what I can see, you can't use XML stored in a PG database. This only works with XML files created using the Symbols Library export functionality. I would suggest we state this clearly. In the begining of reviewing this I was thinking in QML styles and SLD and styles stores in Postgres and geodatabases. But I don't think that's the way it works.

Since the word database is used in the user interface, it is natural that it is also used in the documentation. The user interface should be fixed before the documentation is changed.
I don't think it is a problem to include XML, since that is the file type that comes up as a default in the dialogue.

yjacolin · 2018-09-11T10:51:50Z

source/docs/user_manual/processing_algs/qgis/cartography.rst

+the specified QGIS XML style database. Whenever a matching symbol name is found,
+the category's symbol will be set to this matched symbol.
+The matching is case-insensitive by default, but can be made case-sensitive
+if required.


how user can enable this?

Just add see below or so is enough.

Is it worth? This is a general overview of the capabilities of the alg. User is expected to read the parameters description later on. Also, I'm not sure we add this kind of reference in the other detailed algs. I'd be -0,5 ;)

My first comment is when reading the text, I though howto do this? Then I continue to read and then see the parameter list. My personal experience reading documentation is that you don't know if (and whrere) this kind ofthing will be documented.

I agree with @DelazJ and I would actually go even deeper and would remove from line 27 to line 35. this all can summarized in the parameters. Remember, less text written, less text we need to maintain :-D

I removed lines but kept lines 34-35 as they are about the output of the alg. Might be worth known in the alg description.

SrNetoChan

I think a clarification needs to be done about what kind of Styles file we are talking about. Other than that, is just subjective and cosmetic changes.

SrNetoChan · 2018-09-28T11:42:23Z

source/docs/user_manual/processing_algs/qgis/cartography.rst

+Create categorized renderer from styles |34|
+--------------------------------------------
+Sets a vector layer's renderer to a categorized renderer using matching symbols
+from a style database. If no style file is specified, symbols from the user's


Can we try to avoid the word "database" in here. An XML file is not a database (although I know that one name of the parameters). Maybe "a styles XML file".

Since the word database is used in the user interface, it is natural that it is also used in the documentation. The user interface should be fixed before the documentation is changed.

@havatv I think we can find the right wording here and issue a PR for the interface. Have been done many times in the past.
@SrNetoChan For me database is not that wrong; a db is not about a particular format here but should be read as a container that stores some data in some formalised structure. Also note that symbols used are not only from a provided file but also from the qgis installation (i think it's in a sqlite db format).
I'm however questioned by the use of style vs symbol word

I agree with @DelazJ. Database is fine here.

I would prefer the use of something like symbol collection, but I confess that the first comments I did I was confusing the type of input file. Now, I understand that the expected input file is an XML containing the description of one or more symbols/styles. something we
get from exporting symbols from the Style manager.

I agree with @DelazJ we can create a PR with the name we think is best and, once approved, change the documentation accordingly.

@DelazJ about the name style and symbol, I have already proposed the change of style manager to symbols manager once, but It was vetted by Nyall who has higher plans for it, which, according to him, will make the "style" term make sense for that dialog. For this algorithm, I think I would also prefer the use o the word symbol, since style in the layer context means labels, diagram, fields, etc...

SrNetoChan · 2018-09-28T11:44:57Z

source/docs/user_manual/processing_algs/qgis/cartography.rst

+from a style database. If no style file is specified, symbols from the user's
+current style library are used instead.
+
+The specified expression (or field name) is used to create categories for the


I would not say "field name", but just "field", after all, in the end the algorithm uses the field (values), not the name. I would remove the parenthesis also:

"The specified field or expression is used"

What you can supply here is the field name, but I agree that changing to "The specified field or expression is used" is better (or perhaps "The specified expression or field is used", since expression is used in the user interface).

SrNetoChan · 2018-09-28T11:54:46Z

source/docs/user_manual/processing_algs/qgis/cartography.rst

+The specified expression (or field name) is used to create categories for the
+renderer. A category will be created for each unique value within the layer.
+Each category is individually matched to the symbols which exist within
+the specified QGIS XML style database. Whenever a matching symbol name is found,


Again, please don't call the style a database... QGIS styles XML file?

Note that, for what I can see, you can't use XML stored in a PG database. This only works with XML files created using the Symbols Library export functionality. I would suggest we state this clearly. In the begining of reviewing this I was thinking in QML styles and SLD and styles stores in Postgres and geodatabases. But I don't think that's the way it works.

source/docs/user_manual/processing_algs/qgis/cartography.rst

SrNetoChan · 2018-09-28T11:59:02Z

source/docs/user_manual/processing_algs/qgis/cartography.rst

+the specified QGIS XML style database. Whenever a matching symbol name is found,
+the category's symbol will be set to this matched symbol.
+The matching is case-insensitive by default, but can be made case-sensitive
+if required.


I agree with @DelazJ and I would actually go even deeper and would remove from line 27 to line 35. this all can summarized in the parameters. Remember, less text written, less text we need to maintain :-D

SrNetoChan · 2018-09-28T12:01:44Z

source/docs/user_manual/processing_algs/qgis/cartography.rst

+  Vector layer to apply a categorized style to.
+
+``Categorize using expression`` [expression]
+  Field or rule of categorization of the features.


"Field or expression for categorization(...)"?

Or the other way around (Expression or field for categorization)

for categorization

SrNetoChan · 2018-09-28T12:14:22Z

source/docs/user_manual/processing_algs/qgis/cartography.rst

+  Field or rule of categorization of the features.
+
+``Style database (leave blank to use saved symbols)`` [file]
+  File containing the symbols to apply to the input layer categories.


maybe mention here that this file is an XML from a Symbols library export?

Perhaps "File (XML) containing the symbols..."

SrNetoChan · 2018-09-28T12:15:38Z

source/docs/user_manual/processing_algs/qgis/cartography.rst

+  Default: *False*
+
+``Ignore non-alphanumeric characters while matching`` [boolean]
+  If checked, non-alphanumeric characters in style and category names will be


in the style and category names?

SrNetoChan · 2018-09-28T12:18:30Z

source/docs/user_manual/processing_algs/qgis/cartography.rst

+  Optional
+
+  Lists all existing categories which could not be matched
+  to a symbol in the provided style.


just "List categories"?
to any symbol?
provided styles file?

Lists categories which could not be matched to any symbol in the provided styles database.

SrNetoChan · 2018-09-28T12:19:40Z

source/docs/user_manual/processing_algs/qgis/cartography.rst

+``Non-matching symbol names`` [table]
+  Optional
+
+  Lists all symbol names from the provided style file which could not match


just "Lists symbols..."?
provided styles file?

Lists symbol names from the provided styles database which could not be matched to any...

and a bit more

DelazJ

A first commit to implement what seems to raise consensus in most of the comments... and more ;) Feel free to push commits to the PR or issue PR against the branch if you don't agree with the extra changes: I don't know whether I satisfy the database vs file, style vs symbol old "misuse" but I'd like to not spend more time on this alg (a bit of hassle).

DelazJ · 2018-10-03T14:10:47Z

source/docs/user_manual/processing_algs/qgis/cartography.rst

+Create categorized renderer from styles |34|
+--------------------------------------------
+Sets a vector layer's renderer to a categorized renderer using matching symbols
+from a style database. If no style file is specified, symbols from the user's


@havatv I think we can find the right wording here and issue a PR for the interface. Have been done many times in the past.
@SrNetoChan For me database is not that wrong; a db is not about a particular format here but should be read as a container that stores some data in some formalised structure. Also note that symbols used are not only from a provided file but also from the qgis installation (i think it's in a sqlite db format).
I'm however questioned by the use of style vs symbol word

source/docs/user_manual/processing_algs/qgis/cartography.rst

DelazJ · 2018-10-03T14:12:07Z

source/docs/user_manual/processing_algs/qgis/cartography.rst

+the specified QGIS XML style database. Whenever a matching symbol name is found,
+the category's symbol will be set to this matched symbol.
+The matching is case-insensitive by default, but can be made case-sensitive
+if required.


I removed lines but kept lines 34-35 as they are about the output of the alg. Might be worth known in the alg description.

SrNetoChan · 2018-10-04T00:13:02Z

I was trying to submit a PR but it kept sending me to a 404 page on github so I gave up.

My proposal would be to add the following on line 40:

File (``.XML``) containing the symbols to apply to the input layer categories,
which can be obtained from the Style Manager :ref:`Share symbols <share_symbols>` tool.

@SrNetoChan

Update according to input from @SrNetoChan

havatv · 2018-11-08T17:42:23Z

I tried an edit to resolve the last comment - sorry if that is inappropriate.

DelazJ · 2018-11-08T21:01:09Z

It's more than appropriate @havatv We shouldn't let stale PR, particularly when no more is left to do. I had some concerns with Alex suggestion, reason why I did not update at that time (and forgot this PR) but i can't recall what the issue was.
Let's merge and if ever I remember and it's still valid, a new PR will surface.
Thanks

Add "Create categorized renderer from styles" algorithm

bf95f15

yjacolin reviewed Sep 11, 2018

View reviewed changes

SrNetoChan requested changes Sep 28, 2018

View reviewed changes

Let's try to filter out consensus

b806e79

and a bit more

DelazJ commented Oct 3, 2018

View reviewed changes

havatv approved these changes Oct 3, 2018

View reviewed changes

SrNetoChan approved these changes Oct 4, 2018

View reviewed changes

Update cartography.rst

d24248a

Update according to input from @SrNetoChan

DelazJ merged commit 81163f4 into qgis:master Nov 8, 2018

DelazJ deleted the categorizedStyleAlg branch November 8, 2018 21:03

Add "Create categorized renderer from styles" algorithm #2988

Add "Create categorized renderer from styles" algorithm #2988

Conversation

DelazJ commented Sep 11, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SrNetoChan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DelazJ left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SrNetoChan commented Oct 4, 2018

havatv commented Nov 8, 2018

DelazJ commented Nov 8, 2018