Difference between revisions of "Report snippets"

From Gramps
Jump to: navigation, search
(create framework)
 
m
 
Line 1: Line 1:
{{Languages}}
+
{{Languages|Report_snippets}}
{{man warn|1=&#x1F6A7; Work In Progress|2=This wikipage is an outline from a template being roughed in. Please don't edit '''''just yet'''''. Instead, contribute suggestions on the Discussion page. <br /><br />This page is not planned be linked to a public page until about 2 weeks after 3 February 2021. <br /><br />If this notice remains after that date, please feel welcome to remove this notice and consider the content 'fair game' for unlimited editing.}}
+
Report snippets are small pieces of technical examples showing Formatting and Queries. These snippets could easily be re-used when customizing other reports.
== See also ==
+
==Display Format Tips==
*Feature documentation:[[Start_with_Genealogy|Start with Genealogy]]
+
===displaying parent data to children===
 +
[[:Category:Tutorials|Tutorial]]
  
*[[Gramps_Glossary#active_person|Active Person]] Gramps Glossary definition
+
For the Graphical reports, I wanted to use the Marriage Box to display parent data such as: "Children of Dione and Amirah" or "Children of Dione and Unknown"
  
*based on the [https://sourceforge.net/p/gramps/mailman/gramps-users/ Gramps-users] archived threads:
+
To do this, I used the advanced section in the report options. I replace the strings that had been used as a separator to fill in the blank if the parent was unknown. This technique can be used to replace other strings as well.
:[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=%22Group+As+name%22 threads with "Group As name"]
 
  
 +
Code for Marriage Display Format. (Displays first names of parents.)
  
{{DEFAULTSORT:How do I...new category location|noreplace}}
+
Children of {$n(t f s) $n(n) }  u<,> {and $s(t f s)}
[[Category:Tutorial]]
 
[[Category:WikiContributors]]
 
[[Category:How do I...]]
 
  
 +
Code for Advanced Tab, Replace Display Format:
 +
  u, and/ and
 +
  u,/and Unknown Parent
  
<div style="background:lightcyan">
+
I also use this to Display Descendants and Spouses. It basically gives the last name first and nicknames.
  
 +
  $n(L, t f) {$n('n')} $n(s)
 +
  - { b. $b}{; d. $d}
  
Paste the raw '''[[:Category:Tutorials|Tutorials]]''' outline for the '''[[:Category:How_do_I...|How Do I...]]''' article above the '''See also''' section. This might start with pasting in a copy of a useful thread from one of the Gramps maillists.
+
Happy Charting.
  
 +
== See also ==
 +
*based on the [https://www.reddit.com/r/gramps/ r/Gramps] reddit thread
 +
:[https://www.reddit.com/r/gramps/comments/l44uma/display_format_tips_for_displaying_parent_data_to/ Display Format Tips for displaying parent data to children.] (Posted January 2021 by byu/axiscontra )
  
Saving this file as a 'work in progress' will insert the code behind this reference template. (Preview only show the results, not the markup formatting control.) You can use the appended special formatting example template to pre-populate a virtual Copy&amp;Paste clipboard.  Snip pieces to paste special formatting to enhance the outline.
+
* [[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_4#Advanced_2|Reports - Descendant Tree, options in the Advanced tab]]
 +
* [[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_2#Substitution_Values|Reports - Substitution Values]]
  
----
+
[[Category:Tutorials]]
 
+
[[Category:How do I...]]
Adding a ''feature documentation'' link pointing to the introduction of the interface element in the wiki will relieve you of the burden explaining how to find the feature.
+
[[Category:Reports]]
 
 
Finding a ''[[Gramps_Glossary|Gramps Glossary]] term'' to link may be easier than choosing the best introductory section in the wiki.
 
  <small>&#91;&#91;Gramps_Glossary#active_person|Active Person]]
 
  &#91;&#91;Gramps_Glossary#P|Primary Object]]</small>
 
Glossary terms (like [[Gramps_Glossary#active_person|Active Person]] above) are normally lowercase and use an underscore between words. They have a brief description and may already have the introductory text and practical tutorial linked. You can fall back to the Letter index (like using '[[Gramps_Glossary#P|P]]' with [[Gramps_Glossary#P|Primary Object]] above) if you don't know the exact entry.
 
 
 
Since most of these ''How do I...'' tutorials are likely to have been prompted by a MailList discussion, a set of example 'See also' link are included for reference.
 
 
 
Pointing the ''maillist archived thread'' link to the original message that inspired the tutorial give proper credit for the idea &amp; reveals the background discussion.
 
 
 
Pointing another link to a good search phrase for the archive allows similar discussions to be explored.
 
 
 
----
 
 
 
Once the tutorial Preview is satisfactory, save a revision of the document. Then clean out the virtual Copy&amp;Paste clipboard cluttering up your tutorial and save a final revision.
 
 
 
 
 
To remove the virtual Copy&amp;Paste clipboard, simply delete everything from the beginning of this section to the bottom of the document. It is all disposable.
 
 
 
If the Copy&amp;Paste clipboard is needed again, simply paste the following line at the end of the Edit box, Save a revision, &amp; edit again.(Previewing isn't enough... a revision must be saved.)
 
<pre>  {{subst:Template:How_do_I}}</pre>
 
Other wiki [[:Category:Templates|Templates]] can be used as virtual Copy&amp;Paste clipboards in the same way.
 
 
 
 
 
</div>
 
[[Write_a_%22How_Do_I...%22_Article|Writing a 'How do I...' article.]]
 
<pre>
 
{{subst:Gramps_{{man version}}_Wiki_Manual_-_Preface}}
 
{{subst:WikiContributorRecruiting}
 
</pre>
 
----
 
 
 
== (Section) ==
 
Stub, english (''default'')
 
{{Stub}}
 
 
 
{{Stub|fr}}
 
Stub, french
 
 
 
=== Embeddable Snippets (Subsection) ===
 
Icons
 
: {{icon|gram}} Dashboard
 
: {{icon|peop}} People
 
: {{icon|rela}} Relationships
 
: {{icon|fami}} Family Families
 
: {{icon|ance}} Charts
 
: {{icon|even}} Events
 
: {{icon|plac}} Places
 
: {{icon|geog}} Geography
 
: {{icon|sour34}} Sources
 
: {{icon|cite}} Citations
 
: {{icon|repo}} Repositories
 
: {{icon|medi}} Media
 
: {{icon|note}} Notes
 
:[[Template:Icon/doc|more of the standard icons]]
 
 
 
<small>
 
{|
 
|+ List object tools
 
|-
 
! style="width: 70px"|
 
! style="width: 70px"|
 
! style="width: 70px"|
 
! style="width: 70px"|
 
! style="width: 70px"|
 
! style="width: 70px"|
 
|-
 
!{{icon|stock_add}}
 
!{{icon|share}}
 
!{{icon|stock_edit}}
 
!{{icon|stock_remove}}
 
!{{icon|up}}
 
!{{icon|down}}
 
|-
 
! Add
 
! Share
 
! Edit
 
! Remove
 
! <small>Move<br /></small>Upwards
 
! Move<br />Downwards
 
|}
 
</small>
 
 
 
==== [[Help:Formatting|Text formatting]] (Level 2 Subsection) ====
 
''italic'', '''bold''', '''''bold & italic'''''
 
===== [[Help:Images|Images]] (Level 3 Subsection) =====
 
[[File:ChartsCategory-desendantfan-fullcircle-9gen-default-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} A screenshot caption]]
 
[[Image:Gramps-logo.png|Logo]]
 
 
 
*[[Screenshots|Screenshots]]
 
*[[Special:PrefixIndex|Templates]]
 
====== Annotations of User Activities  (Level 4 Subsection) ======
 
 
 
*<pre>Commands you type at the command line</pre>
 
 
 
*''Filenames'' or <code>Filenames</code>
 
 
 
*<tt>''Replaceable text''</tt>
 
 
 
*{{man label|Labels}} for buttons and other portions of the graphical interface
 
 
 
*{{man tooltip|hint text}} for roll-over tooltip hints that identify elements of the graphical interface
 
 
 
*Menu selections look like this: {{Man menu|Menu &#x27a1; Submenu &#x25B6; Menu Item}} (always pad unicode symbols like these arrows with spaces so that robot translators see recognizable words)
 
* Pop-up menu down {{man button|&#x25BC;}} arrowhead, (triangle) button
 
 
 
*{{man button|Buttons}}  you can click
 
 
 
*{{Man key press|CTRL|D}} see [[Gramps_{{man version}}_Wiki_Manual_-_Keybindings|Keybindings]] for a list of keyboard combinations used in Gramps.
 
 
 
*<tt>Anything you type in</tt>
 
 
 
*{{checkbox|1|Checked}} - [[Template:Checkbox|Selected Checkbox]] &#x2611; template
 
*{{checkbox|0|Unchecked}} - Checkbox that is &#x274f; unselected
 
 
 
== Boxed annotations ==
 
{{man tip| 1=Title of Tip |2=Tips text.}}
 
{{man note|Example Note |Notes text.}}
 
{{man warn|1=WarningTitle/Heading |2=warning text }}</onlyinclude>
 

Latest revision as of 20:01, 3 February 2021

Report snippets are small pieces of technical examples showing Formatting and Queries. These snippets could easily be re-used when customizing other reports.

Display Format Tips

displaying parent data to children

Tutorial

For the Graphical reports, I wanted to use the Marriage Box to display parent data such as: "Children of Dione and Amirah" or "Children of Dione and Unknown"

To do this, I used the advanced section in the report options. I replace the strings that had been used as a separator to fill in the blank if the parent was unknown. This technique can be used to replace other strings as well.

Code for Marriage Display Format. (Displays first names of parents.)

Children of {$n(t f s) $n(n) }  u<,> {and $s(t f s)}

Code for Advanced Tab, Replace Display Format:

 u, and/ and
 u,/and Unknown Parent

I also use this to Display Descendants and Spouses. It basically gives the last name first and nicknames.

 $n(L, t f) {$n('n')} $n(s)
 - { b. $b}{; d. $d}

Happy Charting.

See also

Display Format Tips for displaying parent data to children. (Posted January 2021 by byu/axiscontra )