Difference between revisions of "Develop an Add-on Rule"

From Gramps
Jump to: navigation, search
m
m
Line 6: Line 6:
 
Since you are reading '''''this paragraph''''', then the WikiContributor has not progressed to the point of trimming out the excess template material. That means the wikipage is probably not ready for collaborative editing yet. Multiple people editing ''now'' might unintentionally overwrite their work. Please post your suggestion on the '''Discussion''' page instead of directly editing the content.}}
 
Since you are reading '''''this paragraph''''', then the WikiContributor has not progressed to the point of trimming out the excess template material. That means the wikipage is probably not ready for collaborative editing yet. Multiple people editing ''now'' might unintentionally overwrite their work. Please post your suggestion on the '''Discussion''' page instead of directly editing the content.}}
  
In various rules that allow a Person ID to be selected as a parameter value, both built-in & add-on rules use inconsistent placeholders:
+
In various rules that allow a Person ID to be selected as a parameter value, both [[Gramps_{{man version}}_Wiki_Manual_-_Filters|built-in rules]] & [[Rule_expansions|add-on rules]] use inconsistent placeholders:
  
 
* <Id>
 
* <Id>
Line 17: Line 17:
  
 
What should the standard nomenclature be for the rule names, descriptions & documentation?
 
What should the standard nomenclature be for the rule names, descriptions & documentation?
 +
 +
== Using add-ons to design and test flight Filter Rule ==
 +
Designing and optimizing a quality query is the core of frequently used add-on Filter Rule.
 +
 +
There are some power tool add-ons to help design queries, test the queries and optimize them. with the rules in SuperTool … while also clearing some outstanding requests. And to use the experience to improve the wiki on filters and a writing rules workflow.
 +
 +
Particularly, using [[Addon:Isotammi_addons#SuperTool|SuperTool]], [[Addon:Isotammi_addons#FilterParams_tool|FilterParams]], & the [[Addon:QueryGramplet|Query Gramplet]] add-ons in concert.
 +
== Converting a query to an add-on Filter Rule ==
 +
  
 
== Publishing a new Filter Rule ==
 
== Publishing a new Filter Rule ==
Line 28: Line 37:
 
*[[Gramps_Glossary#filter|Filter]] Gramps Glossary definition
 
*[[Gramps_Glossary#filter|Filter]] Gramps Glossary definition
  
*based on the [https://sourceforge.net/p/gramps/mailman/gramps-users/ Gramps-users] archived threads:
+
*based on the [https://sourceforge.net/p/gramps/mailman/gramps-users/ Gramps Discourse forum] archived threads:
 +
 
 +
<!--
 +
*based on the [https://discourse.gramps-project.org/ Gramps-users] archived threads:
 
:[https://sourceforge.net/p/gramps/mailman/message/36617953/ The Group As name override]  
 
:[https://sourceforge.net/p/gramps/mailman/message/36617953/ The Group As name override]  
 
:[https://sourceforge.net/p/gramps/mailman/search/?q=%22unify+similar+surmanes+%3F%3F%22&mail_list=all unify similar surmanes &#91;sic&#93; thread]
 
:[https://sourceforge.net/p/gramps/mailman/search/?q=%22unify+similar+surmanes+%3F%3F%22&mail_list=all unify similar surmanes &#91;sic&#93; thread]
 
:[https://sourceforge.net/p/gramps/mailman/search/?q=%22Group+As+name%22 threads with "Group As name"]
 
:[https://sourceforge.net/p/gramps/mailman/search/?q=%22Group+As+name%22 threads with "Group As name"]
 +
-->
  
 +
* Feature Requests for add-on custom filter Rules in MantisBT
  
 
{{DEFAULTSORT:How do I...new category location|noreplace}}
 
{{DEFAULTSORT:How do I...new category location|noreplace}}

Revision as of 20:52, 22 September 2022

Gnome-important.png
🚧 Work In Progress

This wikipage is a cloned outline from a template. It is being roughed in.

Since you are reading this paragraph, then the WikiContributor has not progressed to the point of trimming out the excess template material. That means the wikipage is probably not ready for collaborative editing yet. Multiple people editing now might unintentionally overwrite their work. Please post your suggestion on the Discussion page instead of directly editing the content.

In various rules that allow a Person ID to be selected as a parameter value, both built-in rules & add-on rules use inconsistent placeholders:

  • <Id>
  • <id>
  • <person>

It would be better if they were harmonized.

I suspect any variant of <ID> would ambiguous because sometimes these rules (while needing a Person Gramps ID) are in different category custom rules.

What should the standard nomenclature be for the rule names, descriptions & documentation?

Using add-ons to design and test flight Filter Rule

Designing and optimizing a quality query is the core of frequently used add-on Filter Rule.

There are some power tool add-ons to help design queries, test the queries and optimize them. with the rules in SuperTool … while also clearing some outstanding requests. And to use the experience to improve the wiki on filters and a writing rules workflow.

Particularly, using SuperTool, FilterParams, & the Query Gramplet add-ons in concert.

Converting a query to an add-on Filter Rule

Publishing a new Filter Rule

Update the Rule Expansions wiki page

See also


  • Feature Requests for add-on custom filter Rules in MantisBT