Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
how_to:narrative_report_fact_sentence_templates [2020/01/17 15:37]
tatewise [Standard Template Codes]
how_to:narrative_report_fact_sentence_templates [2020/05/22 20:24] (current)
tatewise [Introduction]
Line 2: Line 2:
  
 {{entry>​Customisation/​Fact Types;See Index for related topics}} {{entry>​Customisation/​Fact Types;See Index for related topics}}
 +{{entry>​Customisation/​Fact Witnesses;​-*}}
 +{{entry>​Customisation/​Sentence Templates;​-*}}
 +{{entry>​Customisation/​Witness Roles;-*}}
 {{entry>​Fact Types/​Customisation;​-*}} {{entry>​Fact Types/​Customisation;​-*}}
 +{{entry>​Fact Witnesses/​Customisation;​-*}}
 +{{entry>​Narrative Report/​Sentence Templates;​-*}}
 +{{entry>​Report Window/​Narrative Report/​Sentence Templates;​-*}}
 +{{entry>​Sentence Templates/​Customisation;​-*}}
 +{{entry>​Witness Roles/​Customisation;​-*}}
  
 ===== Introduction ===== ===== Introduction =====
Line 12: Line 20:
 If **Custom Facts** are imported from other products there may be no associated **Sentence Template** as there is no **Fact Definition**,​ so follow the advice in [[Glossary:​Work with Fact Sets]] under **Custom Facts from other Products**. If **Custom Facts** are imported from other products there may be no associated **Sentence Template** as there is no **Fact Definition**,​ so follow the advice in [[Glossary:​Work with Fact Sets]] under **Custom Facts from other Products**.
  
-[[Glossary:​Family Historian]] ({{fh}}) **V6** added a special custom **Fact Set** primarily for **FTM** migrants, but it can be used by anyone. Select the **Extended Set** from the **Fact Set** drop list, and follow the popup instructions ​to reveal its details.+[[Glossary:​Family Historian]] ({{fh}}) **V6** added a special custom **Fact Set** primarily for **FTM** migrants, but it can be used by anyone. Select the [[Glossary:​Work with Fact Sets#Custom Facts from other Products|Extended Set]] from the **Fact Set** drop list, and tick **Show Hidden** ​to reveal its details.
  
 ===== Finding Sentence Templates ===== ===== Finding Sentence Templates =====
Line 36: Line 44:
 {{ narrative_report_sentence_defaults.png?​700 |Default Sentence Templates}} {{ narrative_report_sentence_defaults.png?​700 |Default Sentence Templates}}
  
-**Tip:** If you intend to extensively modify the default **Sentence Template** definitions for many **Facts**, ​then it is advisable to use the **Fact Sets** button and **Clone** the appropriate ​fact set, especially the **Standard** set. That allows ​the two alternative definition styles to be easily swapped via the **Fact Set** priority order. ​Such scenarios could include creating a fact list style or a foreign language style.+**Tip:​** ​Such fact definition scenarios could include creating a fact list style or a foreign language style as alternatives to the default style. ​If you intend to extensively modify the default **Sentence Template** definitions for many **Facts**, it is advisable to use the **Fact Sets** button and **Clone** the chosen ​fact set, especially the **Standard** set. That allows ​any alternative definition styles to be easily swapped via the **Fact Set** priority order. ​Only the highest priority **Fact Set** will list its definitions,​ and its clones will appear to have **No Events ​or Attributes** unless **Show Hidden** is ticked to reveal their **<​eclipsed>​ <​disabled>​** definitions.
  
 ==== Specific Fact Sentences ==== ==== Specific Fact Sentences ====
Line 52: Line 60:
 ===== Standard Template Codes ===== ===== Standard Template Codes =====
  
-Most of the **Standard Codes** are simple names enclosed in curly brackets, such as <color #​0/#​E0E0E0>​{individual}</​color> ​or <color #​0/#​E0E0E0>​{date}</​color> ​that represent the **Name of Individual** or the **Date** field respectively. They can be inserted from the **%%<<​%%Insert Code** button, and for full details choose the **How to Use Advanced Features** option and scroll up the **Help** page. If the **Fact** field associated with a **Code** is empty, then nothing appears in the **Sentence**.+Most of the **Standard Codes** are simple names enclosed in curly brackets, such as ''​{individual}'' ​or ''​{date}'' ​that represent the **Name of Individual** or the **Date** field respectively. They can be inserted from the **%%<<​%%Insert Code** button, and for full details choose the **How to Use Advanced Features** option and scroll up the **Help** page. If the **Fact** field associated with a **Code** is empty, then nothing appears in the **Sentence**.
  
-{{fh}} **V6** added new codes for witnesses and formatting. The **Witness Role Codes** apply to witnesses associated with a fact, the **Formatting Codes** of <color #​0/#​E0E0E0>​<br></​color> ​and <color #​0/#​E0E0E0>​<​para>​</​color> ​force a **New Line** or **New Paragraph**,​ and the special ​<color #​0/#​E0E0E0>​{blank}</​color> ​code inhibits the sentence completely. See the [[#​Alternative Sentence Templates]] below for examples of their use.+{{fh}} **V6** added new codes for witnesses and formatting. The **Witness Role Codes** apply to witnesses associated with a fact, the **Formatting Codes** of ''​<br>'' ​and ''​<​para>​'' ​force a **New Line** or **New Paragraph**,​ and the special ​''​{blank}'' ​code inhibits the sentence completely. See the [[#​Alternative Sentence Templates]] below for examples of their use.
  
 ===== Advanced Template Codes ===== ===== Advanced Template Codes =====
Line 123: Line 131:
  
 //​Template://​\\ //​Template://​\\
-''​{individual} appeared in the ''​\\ +''​{individual} appeared in the\\ 
-''​{=TextIf(GetDisplayText(%FACT.DATE%,​min) = "29 September 1939","​National Register","​Census"​)} ​''​\\ + {=TextIf(GetDisplayText(%FACT.DATE%,​min) = "29 September 1939","​National Register","​Census"​)}\\ 
-''​{date} residing at {_place} {age}<​br>''​\\+ {date} residing at {_place} {age}<​br>''​\\
 //​Sentence://​\\ //​Sentence://​\\
 ''​He appeared in the Census on 31 March 1901 residing at 8 Main St, Oxford, England aged 48.''​\\ ''​He appeared in the Census on 31 March 1901 residing at 8 Main St, Oxford, England aged 48.''​\\
Line 134: Line 142:
  
 //​Template://​\\ //​Template://​\\
-''​{couple} appeared in the ''​\\ +''​{couple} appeared in the\\ 
-''​{=TextIf(GetDisplayText(%FACT.DATE%,​min) = "29 September 1939","​National Register","​Census"​)} ​''​\\ + {=TextIf(GetDisplayText(%FACT.DATE%,​min) = "29 September 1939","​National Register","​Census"​)}\\ 
-''​{date} residing at {_place} {their ages}<​br>''​\\+ {date} residing at {_place} {their ages}<​br>''​\\
 //​Sentence://​\\ //​Sentence://​\\
 ''​They appeared in the Census on 31 March 1901 residing at 8 Main St, Oxford, England when he was 34 and she was 31.''​ ''​They appeared in the Census on 31 March 1901 residing at 8 Main St, Oxford, England when he was 34 and she was 31.''​
Line 147: Line 155:
  
 //​Template://​\\ //​Template://​\\
-''​{individual} was born< {date}><​ {place}><​ ({age})>​{=CombineText( Text( " and is " . FileRoot() . "'​s "​), ​''​\\ +''​{individual} was born< {date}><​ {place}><​ ({age})>​{=CombineText( Text( " and is " . FileRoot() . "'​s "​),​\\ 
-''​TextIf(IsSameItem(FileRoot(),​%CUR_PRIN%) or IsSameItem(FileRoot(),​%CUR_PRIN.~FATH>​%) or ''​\\ + TextIf(IsSameItem(FileRoot(),​%CUR_PRIN%) or IsSameItem(FileRoot(),​%CUR_PRIN.~FATH>​%) or\\ 
-''​IsSameItem(FileRoot(),​%CUR_PRIN.~MOTH>​%),​ "",​ Relationship(FileRoot(),​%CUR_PRIN%,​TEXT,​1) ) )}''​\\+ IsSameItem(FileRoot(),​%CUR_PRIN.~MOTH>​%),​ "",​ Relationship(FileRoot(),​%CUR_PRIN%,​TEXT,​1) ) )}''​\\
 //​Sentence://​\\ //​Sentence://​\\
 ''​He was born on 1 May 1900 in London and is John Smith'​s grandfather.''​ ''​He was born on 1 May 1900 in London and is John Smith'​s grandfather.''​
Line 156: Line 164:
  
 //​Template://​\\ //​Template://​\\
-''​{individual} was baptised<​ {date}><​ {place}><​ {age}>​{=CombineText( Text( " and is " . FileRoot() . "'​s "​), ​''​\\ +''​{individual} was baptised<​ {date}><​ {place}><​ {age}>​{=CombineText( Text( " and is " . FileRoot() . "'​s "​),​\\ 
-''​TextIf(IsSameItem(FileRoot(),​%CUR_PRIN%) or IsSameItem(FileRoot(),​%CUR_PRIN.~FATH>​%) or ''​\\ + TextIf(IsSameItem(FileRoot(),​%CUR_PRIN%) or IsSameItem(FileRoot(),​%CUR_PRIN.~FATH>​%) or\\ 
-''​IsSameItem(FileRoot(),​%CUR_PRIN.~MOTH>​%) or Exists(%CUR_PRIN.BIRT%),​ "",​ Relationship(FileRoot(),​%CUR_PRIN%,​TEXT,​1) ) )}.''​\\ + IsSameItem(FileRoot(),​%CUR_PRIN.~MOTH>​%) or Exists(%CUR_PRIN.BIRT%),​ "",​ Relationship(FileRoot(),​%CUR_PRIN%,​TEXT,​1) ) )}.\\ 
-''​< The godparents were {role(plural)=godparent}.><​ The godparent was {role(single)=godparent}.>​''​\\ + < The godparents were {role(plural)=godparent}.><​ The godparent was {role(single)=godparent}.>​\\ 
-''​< The ceremony was conducted by {role=minister}.><​ The ceremony was conducted by {role=priest}.>​}''​\\+ < The ceremony was conducted by {role=minister}.><​ The ceremony was conducted by {role=priest}.>​}''​\\
 //​Sentence://​\\ //​Sentence://​\\
 ''​He was baptised on 3 June 1900 in London and is John Smith'​s grandfather.''​ ''​He was baptised on 3 June 1900 in London and is John Smith'​s grandfather.''​