Value aggregation type #386

iainhallam · 2018-02-26T16:35:49Z

This addition addresses #145 and adds an inline syntax following the existing Struct model, plus a shorthand for a single variable; examples follow.

Value from the current page:

{{$myschema.myfield}}

Value from another page:

{{$"ns:second.page".myschema.myfield}}

Filters can be added manually following a question mark; to keep flexibility for future features like summarize, this means you need to restrict to the page you want yourself. Filters must be in double quotes:

{{$$ID$.myschema.myfield ? filter: "myfield < 5" or: "myfield > 5"}}

Filtering supports the usual Struct keywords, filter, where, filterand, and, filteror, or, followed immediately by a colon, or the shortcuts & and |. The value above can be written:

{{$$ID$.myschema.myfield ? & "myfield < 5" | "myfield > 5"}}

iainhallam · 2018-12-05T23:31:09Z

I think that this check failed due to external factors - is there a way to rerun the tests?

iainhallam · 2019-02-18T12:45:24Z

@splitbrain I believe the build failure was at the time that the stable build didn't work with PHP 7 - is it possible to rerun the tests any way, please?

eilko · 2019-03-14T20:26:00Z

@splitbrain can this request be merged please?

moz0817 · 2019-03-16T16:19:07Z

Very useful extension - thank you very much. I have two annotations:

1: It don't works with relative sites like sidebar or pageheader. This might be useful two.
2: If the shown values would be inline editable - my luck would be unbelievable ;-). Then it's possible to create your own edit forms.

annda · 2019-04-23T12:27:10Z

This looks very good, I would also like to see the inline syntax merged. The new feature probably does not require any test, maybe for the InlineConfigParser

@splitbrain what do you think?

splitbrain

I like the idea and agree that it should be merged soon. The code looks very good already, but there are some things I'd like to see addressed first. See my inline comments for details.

splitbrain · 2019-04-23T12:34:40Z

meta/AggregationValue.php

+     * 
+     * @param  int  $show_not_found  Whether to display the default text for no records
+     */
+    public function render($show_not_found = 0) {


It would probably be better to pass a boolean here.

This is taken directly from the config array, so will always be given a 0 or 1 depending on the config file. Should I convert a config 0 to Boolean false and config 1 to Boolean true before making use of the value, @splitbrain?

yeah, I would convert it.

meta/AggregationValue.php

meta/InlineConfigParser.php

syntax/value.php

meta/InlineConfigParser.php

splitbrain · 2019-04-23T12:55:32Z

syntax/value.php

+
+            /** @var AggregationValue $value */
+            $value = new AggregationValue($INFO['id'], $mode, $renderer, $search);
+            $value->render($show_not_found);


the above does not need to happen during metadata rendering.

Is this not where the value would be put into the text of the abstract when rendering metadata? This is quite a complex part of the DokuWiki code and I'm not at all sure I understand it!

Hmm, I think you might be right. I forgot about that. Maybe give it a quick try by putting the value right at the top of the page and see what ends up in the abstract

…/dokuwiki-plugin-struct#386 for more detail.

fschrempf · 2021-01-06T19:37:21Z

@iainhallam Do you intend to respond to @splitbrain's review comments above?
It would be great to have this merged and it looks like you were close to bring this over the finish line back in 2018.

fschrempf · 2021-01-24T14:29:41Z

One other thing I noticed with a rather special use case:

I want to overwrite the meta page title with data from a struct field. So I tested this PR in combination with the page title plugin. The page content rendering is correct, but the meta title shows "Nothing found" when show_not_found is enabled. So somehow the struct data is not passed to the meta renderer correctly!?

====== Header1 {{"$test.test"}} ======

Struct data: {{$test.test}}

<title>
{{$test.test}}
</title>

becomes:

iainhallam · 2021-01-25T18:47:23Z

@iainhallam Thanks a lot for picking up this work. I just tested your latest changes and while I can get the value from the schema to be rendered correctly in normal text, it doesn't work in headings. Is this a known/expected limitation?

This is a limitation of DokuWiki - you can't have any syntax inside headers:

https://www.dokuwiki.org/faq:headerlinks

fschrempf · 2021-01-25T19:12:02Z

Ok, for the first example. That's a DokuWiki limitation. What about the second example using the pagetitle plugin? I think that's a different case, as the syntax is actually parsed, only the data is missing in the meta rendering.

iainhallam · 2021-01-25T20:14:59Z

Ok, for the first example. That's a DokuWiki limitation. What about the second example using the pagetitle plugin? I think that's a different case, as the syntax is actually parsed, only the data is missing in the meta rendering.

I'll need to take some time to delve into this - I don't feel I have a handle on the metadata parts of DW at the moment.

fschrempf · 2021-01-25T21:54:59Z

I'll need to take some time to delve into this - I don't feel I have a handle on the metadata parts of DW at the moment.

Sure. I had a quick look for myself, but unfortunately I couldn't get the hang of it either so far. And I'm not even sure if this should be in the scope of this PR or rather something to look at after getting this merged.

Juergen-aus-Zuendorf · 2021-01-26T10:08:01Z

@iainhallam:
Could you perhaps test if your changes would support to use this variable inside an aggregation as filter, described in issue #145, comment "on 2 Apr 2019" ?

Example:

---- struct table ----
schema : fbg_ident, fbg_meta
cols   : fbg_ident.fbg-fkt, fbg_meta.fbg-mtyps
filter : fbg-schlagwort = {{$my_page.fbg_meta.fbg-mtyps}}
----

This would be extremely helpful. Thanks a lot in advance

Regards, Juergen

iainhallam · 2021-01-26T10:29:42Z

@Juergen-aus-Zuendorf

---- struct table ----
schema : fbg_ident, fbg_meta
cols   : fbg_ident.fbg-fkt, fbg_meta.fbg-mtyps
filter : fbg-schlagwort = {{$my_page.fbg_meta.fbg-mtyps}}
----

This is already available for the current page using the format filter : fbg-schlagwort = $STRUCT.fbg_meta.fbg-mtyps$. See the docs at:

https://www.dokuwiki.org/plugin:struct:filters

My changes essentially add an inline syntax to the Struct configuration parser and an aggregation to display a single value, so this would be a change to the Struct configuration parser logic itself, that would need to add the ability to specify a page in that type of filter. Can you raise a separate issue for that, please?

splitbrain · 2021-04-21T08:13:30Z

Sorry for the delay in answering your comments. @annda if you're working on this, maybe fix the few little things from above right on merging.

annda · 2021-04-21T19:56:45Z

I find this feature very useful and would like to finally merge it.

I have two questions though:

serial data: At this point there is no check on rid so the search might in some rare cases return serial data instead of page data. Is this something we should be concerned about? (Probably simply adding %rowid% = 0 to the filters in InlineConfigParser would take care of that.)

syntax: The {{$...}} pattern is concise and easy to write, but there is no obvious association with the plugin it belongs to. As someone who often needs to troubleshoot, I prefer the earlier version of {{structvalue ...}}. Any opinions on that, everyone?

Juergen-aus-Zuendorf · 2021-04-22T06:34:19Z

Although due to the long time span in the meantime, I already worked with iainhallam's extension (thanks for this) and now I would have to adjust the syntax everywhere:
On the one hand, {{structvalue ...}} is much better for association with the plugin. On the other hand, if you might want to search and replace syntax elements of the function, you can easily search the keyword "structvalue" with dokuwiki's search mechanism.

One more question: What's about the filtering syntax "{{$$..."?

iainhallam · 2021-04-26T09:55:41Z

One more question: What's about the filtering syntax "{{$$..."?

@Juergen-aus-Zuendorf Where's that syntax used; have you got an example?

Juergen-aus-Zuendorf · 2021-04-26T12:50:26Z

Perhaps this is a misunderstanding from myside:

At the beginning of this thread you described the following:
{{$$ID$.myschema.myfield ? & "myfield < 5" | "myfield > 5"}}
Therefore, my previous question: "What's about the filtering syntax "{{$$..."?"
Is it possible to use placeholders within the syntax? And how should it be written in this case?

iainhallam · 2021-05-22T11:42:58Z

At the beginning of this thread you described the following:
{{$$ID$.myschema.myfield ? & "myfield < 5" | "myfield > 5"}}
Therefore, my previous question: "What's about the filtering syntax "{{$$..."?"
Is it possible to use placeholders within the syntax? And how should it be written in this case?

Ah. The configuration is mainly syntactic sugar, so it passes the page ID straight on to the main Struct parser. That syntax is actually the same {{$ with the ID placeholder from the main Struct documentation, $ID$ (meaning this current page), as the page name.

It would perhaps be clearer to require a user to specify that they want the query to apply to all pages with something like:

/* Current page */
{{$myschema.myfield ? filter: "myfield < 5" or: "myfield > 5"}}

/* Specific page */
{{$other-page.myschema.myfield ? filter: "myfield < 5" or: "myfield > 5"}}

/* Search all pages */
{{$*.myschema.myfield ? filter: "myfield < 5" or: "myfield > 5"}}

Juergen-aus-Zuendorf · 2021-05-25T12:17:05Z

I think your suggestion is very good!

Alternatively, I would find it just as good to use the automatism with the placeholders, if this is documented in detail in the plugin description.

And once again my attempt (as syntactic sugar):
Couldn't the filtering likewise support the comparison with a Struct value of another page, e.g. in this form:
{{$myschema.myfield ? filter: "myfield = {{$other-page.otherschema.otherfield}}"}}

Best regards
Juergen

iainhallam · 2021-05-26T00:39:16Z

I think your suggestion is very good!

Will have a go at redoing that part when I can.

Couldn't the filtering likewise support the comparison with a Struct value of another page, e.g. in this form:
{{$myschema.myfield ? filter: "myfield = {{$other-page.otherschema.otherfield}}"}}

Struct already has a syntax for that, and your bug report #552 should take care of specific pages. I won't be adding it to this aggregation.

annda · 2021-06-17T12:45:37Z

@iainhallam Can you update the documentation?

iainhallam · 2021-08-20T18:10:49Z

Documentation updated at https://www.dokuwiki.org/plugin:struct:aggregation.

iainhallam added 8 commits January 28, 2018 23:48

Allow a single value to be used inline in the page

1d61b85

Removed debug line

8007bd8

Added short form of value syntax - {{$s.f}}

e24c22f

Refactor inline parsing into a new class and add filtering for page ID

5baf820

Allow recovery if the user has used single quotes

7a29cdf

Fixed metadata rendering when using $INFO['id']

5dadde8

Handle no result better

66c182e

Add configuration for whether to show a no records text

4caec65

splitbrain reviewed Apr 23, 2019

View reviewed changes

neoocean added a commit to neoocean/neoocean.net-dokuwiki-1 that referenced this pull request Jan 15, 2020

Applied 'Value aggregation type #386' to struct plugin. See cosmocode…

bbc6cd8

…/dokuwiki-plugin-struct#386 for more detail.

neoocean added a commit to neoocean/neoocean.net-dokuwiki-1 that referenced this pull request Jan 15, 2020

Applied 'Value aggregation type #386' to struct plugin. See cosmocode…

7ad9c13

…/dokuwiki-plugin-struct#386 for more detail.

fschrempf mentioned this pull request Jan 6, 2021

Struct data as variables #145

Closed

iainhallam added 9 commits January 20, 2021 16:33

Update to current master branch

b5bc154

Linter fixes

46c73db

Match array style with other entries

e08d3f4

Simplify tokenising with -> separator

16475a3

Replace use of GLOBALS array

52688a6

Revert to dots, remove block syntax

afaa8e1

Suggestion of future syntax

550a937

Use space-separated parameters

c253a75

Explanatory comments

866e578

This comment has been minimized.

Sign in to view

iainhallam added 2 commits January 25, 2021 18:56

Increase sort order

cf42daf

Don't lint for errors required by DokuWiki

ca6d556

iainhallam marked this pull request as draft January 25, 2021 19:06

iainhallam added 2 commits January 25, 2021 19:35

Move syntax description to class documentation

71393be

Draft InlineConfigParser test

ee1b9da

Juergen-aus-Zuendorf mentioned this pull request Jan 26, 2021

Struct data from a specific page as filter for aggregation #552

Open

Docstring alignment

752f8cc

iainhallam requested a review from splitbrain February 7, 2021 13:38

iainhallam marked this pull request as ready for review March 13, 2021 15:24

annda merged commit 812a20f into cosmocode:master Jun 17, 2021

iainhallam deleted the feature/value branch August 20, 2021 18:11

Value aggregation type #386

Value aggregation type #386

Conversation

iainhallam commented Feb 26, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iainhallam commented Dec 5, 2018

Uh oh!

iainhallam commented Feb 18, 2019

Uh oh!

eilko commented Mar 14, 2019

Uh oh!

moz0817 commented Mar 16, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

annda commented Apr 23, 2019

Uh oh!

splitbrain left a comment

Choose a reason for hiding this comment

Uh oh!

splitbrain Apr 23, 2019

Choose a reason for hiding this comment

Uh oh!

iainhallam Jan 20, 2021

Choose a reason for hiding this comment

Uh oh!

splitbrain Apr 21, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

splitbrain Apr 23, 2019

Choose a reason for hiding this comment

Uh oh!

iainhallam Jan 20, 2021

Choose a reason for hiding this comment

Uh oh!

splitbrain Apr 21, 2021

Choose a reason for hiding this comment

Uh oh!

fschrempf commented Jan 6, 2021

Uh oh!

This comment has been minimized.

fschrempf commented Jan 24, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iainhallam commented Jan 25, 2021

Uh oh!

fschrempf commented Jan 25, 2021

Uh oh!

iainhallam commented Jan 25, 2021

Uh oh!

fschrempf commented Jan 25, 2021

Uh oh!

Juergen-aus-Zuendorf commented Jan 26, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iainhallam commented Jan 26, 2021

Uh oh!

splitbrain commented Apr 21, 2021

Uh oh!

annda commented Apr 21, 2021

Uh oh!

Juergen-aus-Zuendorf commented Apr 22, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iainhallam commented Apr 26, 2021

Uh oh!

Juergen-aus-Zuendorf commented Apr 26, 2021

Uh oh!

iainhallam commented May 22, 2021

Uh oh!

Juergen-aus-Zuendorf commented May 25, 2021

Uh oh!

iainhallam commented May 26, 2021

Uh oh!

iainhallam commented Feb 26, 2018 •

edited

Loading

moz0817 commented Mar 16, 2019 •

edited

Loading

fschrempf commented Jan 24, 2021 •

edited

Loading

Juergen-aus-Zuendorf commented Jan 26, 2021 •

edited

Loading

Juergen-aus-Zuendorf commented Apr 22, 2021 •

edited

Loading