Difference between revisions of "Template:Show grouped labels of concept collection/doc"

From TDWG Terms Wiki
Jump to: navigation, search
m (→‎Technical Documentation)
m (+todo)
Line 4: Line 4:
 
* Concept collection is a section
 
* Concept collection is a section
 
* labels and concept names become grouped as a list
 
* labels and concept names become grouped as a list
 +
 +
Note: at the moment the template …
 +
* finds either concepts that are only in collections or
 +
* finds concepts when there are no collections at all
 +
TODO:
 +
* find concepts that have no collections ''and'' concepts in collections
  
 
== Usage ==
 
== Usage ==

Revision as of 13:23, 20 January 2020

This is a documentation subpage for Template:Show grouped labels of concept collection (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

Summary: Show and list (all) labels and concept names of one concept collection but format it nicely:

  • Concept collection is a section
  • labels and concept names become grouped as a list

Note: at the moment the template …

  •  finds either concepts that are only in collections or
  • finds concepts when there are no collections at all

TODO:

  • find concepts that have no collections and concepts in collections

Usage

{{Show grouped labels of concept collection|ABCD 2}}

or with parameter: 

{{Show grouped labels of concept collection
|skos-inScheme=ABCD 2
}}

On a page named “ABCD 2” it is possible to use this template without parameters (so the Wiki page name will be used as value for the requested concept scheme): 

{{Show grouped labels of concept collection}}


Parameters

Bold parameters are mandatory, all other are optional:

Parameter Comment, Example Default
|skos-inScheme= |1= the name of the scheme, eg “ABCD 2” (the Wiki page name is used)
|skos-inScheme limit= the requested limit of property: skos:inScheme collections 100
|in collection concepts limit= the requested limit within one collection itself (not the overall limit) 1000

Technical Documentation

Dependencies:

Query and Rendering Optimisation

It is fasted to use pre-formatted properties to just display them in conjunction of #ask. When using template rendering within #ask it slows down as the number of concepts grows.

Use Case Number of Concepts Response time
  • pre-formatted properties
 1400 2-3 sec.
  • inline query with template calls
1400  5-7 sec.
  • global array that gets filtered for concept collections
 1400  5(6)-7(8) sec.

Perhaps there is still room for optimisations.


Retrieved from "https://terms.tdwg.org/w/index.php?title=Template:Show_grouped_labels_of_concept_collection/doc&oldid=46544"