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

From Gramps
Jump to: navigation, search
(Created page with "{{subst:Template:How_do_I}}")
 
m
Line 1: Line 1:
{{Languages}}
+
<!--
 +
{{Languages|Develop_an_Add-on_Rule}}
 +
-->
 
{{man warn|1=&#x1F6A7; Work In Progress|2=This wikipage is a cloned outline from a template. It is being roughed in.  
 
{{man warn|1=&#x1F6A7; Work In Progress|2=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.}}
 
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:
 +
 +
* &lt;Id>
 +
* &lt;id>
 +
* &lt;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?
 +
 +
== Publishing a new Filter Rule ==
 +
 +
[[Rule_expansions|Update the Rule Expansions wiki page]]
 
== See also ==
 
== See also ==
*Feature documentation:[[Start_with_Genealogy|Start with Genealogy]]
+
* Developer documentation
 
+
** [[Addons_development|Addons development]]
*[[Gramps_Glossary#active_person|Active Person]] Gramps Glossary definition
+
** [[Writing_a_plugin|Writing a plugin]]
 +
** [[Getting_started_with_Gramps_development|Getting started with Gramps development]]
 +
*[[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-users] archived threads:
Line 19: Line 39:
 
[[Category:How do I...]]
 
[[Category:How do I...]]
  
 
+
<!--
 
<div style="background:lightcyan">
 
<div style="background:lightcyan">
  
Line 153: Line 173:
 
{{man note|Example Note |Notes text.}}
 
{{man note|Example Note |Notes text.}}
 
{{man warn|1=WarningTitle/Heading |2=warning text }}</onlyinclude>
 
{{man warn|1=WarningTitle/Heading |2=warning text }}</onlyinclude>
 +
 +
-->

Revision as of 18:35, 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 & 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?

Publishing a new Filter Rule

Update the Rule Expansions wiki page

See also

The Group As name override
unify similar surmanes [sic] thread
threads with "Group As name"