Difference between revisions of "Template:How do I"

From Gramps
m
m
Line 9: Line 9:
 
:[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"]
  
 +
<noinclude>
 +
 +
The '''&lt;IncludeOnly>''' tagged information is ignored until a template is transcluded. These tags suppress elements from being parsed for application to the original template. The usage below keeps the Template:How_do_I page itself from being indexed in those Categories.
 +
<pre>&lt;includeonly>
 +
[[Category:Tutorial]]
 +
[[Category:WikiContributors]][[Category:How do I...]]
 +
&lt;/includeonly></pre>
 +
 +
</noinclude><includeonly>
 +
[[Category:Tutorial]]
 +
[[Category:WikiContributors]][[Category:How do I...]]
 +
</includeonly>
 +
 +
<div style="background:lightcyan">
 +
 +
 +
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.
 +
 +
 +
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.
 +
 +
----
 +
 +
Since most of these tutorial are likely to be inspired by a MailList discussion, a set of example 'See also' link are included for reference.
 +
 +
Adding a 1st link pointing to the introduction of the interface element in the wiki will relive you of the burden explaining how to find the feature.
 +
 +
Pointing the 2nd link to the original message that inspired the tutorial give proper credit for the idea &amp; reveals the background discussion.
 +
 +
Pointing the third 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>
 
<pre>
 
{{subst:Gramps_5.1_Wiki_Manual_-_Preface}}
 
{{subst:Gramps_5.1_Wiki_Manual_-_Preface}}
 
+
{{subst:WikiContributorRecruiting}
{{subst:{{subst:WikiContributorRecruiting}}}}
 
 
</pre>
 
</pre>
 
----
 
----
<pre>{{subst:Gramps_5.1_Wiki_Manual_-_Preface}}
 
</pre>
 
Put the Table Of Contents wherever you like
 
__FORCETOC__
 
== Section ==
 
{{Stub|fr}}Stub, french
 
  
=== [[Template:Icon/doc|List of icons]] Subsection ===
+
== (Section) ==
Dashboard: {{icon|gram}}<br>
+
Stub, english (''default'')
People People: {{icon|peop}}<br>
+
{{Stub}}
Relationships: {{icon|rela}}<br>
+
 
Family Families: {{icon|fami}}<br>
+
{{Stub|fr}}
Ancestry Charts: {{icon|ance}}<br>
+
Stub, french
Events Events: {{icon|even}}<br>
 
Places Places: {{icon|plac}}<br>
 
Geography Geography: {{icon|geog}}<br>
 
Sources (v3.4.x) Sources: {{icon|sour34}}<br>
 
Citations Citations: {{icon|cite}}<br>
 
Repositories Repositories: {{icon|repo}}<br>
 
Media Media: {{icon|medi}}<br>
 
Notes Notes: {{icon|note}}
 
  
==== [[Help:Formatting|Text formatting]] Level 2 Subsection ====
+
=== Embeddable Snippets (Subsection) ===
 +
Icons
 +
:Dashboard: {{icon|gram}}
 +
:People People: {{icon|peop}}
 +
:Relationships: {{icon|rela}}
 +
:Family Families: {{icon|fami}}
 +
:Ancestry Charts: {{icon|ance}}
 +
:Events Events: {{icon|even}}
 +
:Places Places: {{icon|plac}}
 +
:Geography Geography: {{icon|geog}}
 +
:Sources (v3.4.x) Sources: {{icon|sour34}}
 +
:Citations Citations: {{icon|cite}}
 +
:Repositories Repositories: {{icon|repo}}
 +
:Media Media: {{icon|medi}}
 +
:Notes Notes: {{icon|note}}
 +
:[[Template:Icon/doc|more of the standard icons]]
 +
==== [[Help:Formatting|Text formatting]] (Level 2 Subsection) ====
 
''italic'', '''bold''', '''''bold & italic'''''
 
''italic'', '''bold''', '''''bold & italic'''''
===== [[Help:Images|Images]] Level 3 Subsection =====
+
===== [[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]]
 
[[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]]  
 
[[Image:Gramps-logo.png|Logo]]  
  
====== Level 4 Subsection ======
+
*[[Screenshots|Screenshots]]
 
+
*[[Special:PrefixIndex|Templates]]
 +
====== Annotations of User Activities  (Level 4 Subsection) ======
  
 
*<pre>Commands you type at the command line</pre>
 
*<pre>Commands you type at the command line</pre>
Line 58: Line 105:
 
*{{man button|Buttons}}  you can click
 
*{{man button|Buttons}}  you can click
  
*{{Man key press|CTRL|D}} [[Gramps_5.1_Wiki_Manual_-_Keybindings|Key combinations]] you can press on your Keyboard.
+
*{{Man key press|CTRL|D}} see [[Gramps_5.1_Wiki_Manual_-_Keybindings|Keybindings]] for a list of keyboard combinations used in Gramps.
  
 
*<tt>Anything you type in</tt>
 
*<tt>Anything you type in</tt>
Line 64: Line 111:
 
*{{checkbox|1|Checked}} - Checkbox that is selected
 
*{{checkbox|1|Checked}} - Checkbox that is selected
 
*{{checkbox|0|Unchecked}} - Checkbox that is unselected
 
*{{checkbox|0|Unchecked}} - Checkbox that is unselected
To
+
 
 +
== Boxed annotations ==
 
{{man tip| 1=Title of Tip |2=Tips text.}}
 
{{man tip| 1=Title of Tip |2=Tips text.}}
{{man note| Example Note |Notes text.}}
+
{{man note|Example Note |Notes text.}}
{{man warn|1=Title/Heading |2=warning text }}</onlyinclude>
+
{{man warn|1=WarningTitle/Heading |2=warning text }}</onlyinclude>
 
 
 
 
<includeonly>
 
[[Category:Documentation]]
 
[[Category:WikiContributors]][[Category:How do I...]]
 
</includeonly>
 

Revision as of 22:16, 25 September 2019

See also

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


The <IncludeOnly> tagged information is ignored until a template is transcluded. These tags suppress elements from being parsed for application to the original template. The usage below keeps the Template:How_do_I page itself from being indexed in those Categories.

<includeonly>
[[Category:Tutorial]]
[[Category:WikiContributors]][[Category:How do I...]]
</includeonly>



Paste the raw Tutorials outline for the 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.


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&Paste clipboard. Snip pieces to paste special formatting to enhance the outline.


Since most of these tutorial are likely to be inspired by a MailList discussion, a set of example 'See also' link are included for reference.

Adding a 1st link pointing to the introduction of the interface element in the wiki will relive you of the burden explaining how to find the feature.

Pointing the 2nd link to the original message that inspired the tutorial give proper credit for the idea & reveals the background discussion.

Pointing the third 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&Paste clipboard cluttering up your tutorial and save a final revision.


To remove the virtual Copy&Paste clipboard, simply delete everything from the beginning of this section to the bottom of the document. It is all disposable.

If the Copy&Paste clipboard is needed again, simply paste the following line at the end of the Edit box, Save a revision, & edit again.(Previewing isn't enough... a revision must be saved.)

   {{subst:Template:How_do_I}}

Other wiki Templates can be used as virtual Copy&Paste clipboards in the same way.


Writing a 'How do I...' article.

{{subst:Gramps_5.1_Wiki_Manual_-_Preface}}
{{subst:WikiContributorRecruiting}

(Section)

Stub, english (default)

Gramps-notes.png

This article's content is incomplete or a placeholder stub.
Please update or expand this section.


Gramps-notes.png

Ébauche

À compléter !

Si vous pouvez aider à la traduction ou l'adapter à la culture francophone.

N'hésitez pas à améliorer cette page.


Stub, french

Embeddable Snippets (Subsection)

Icons

Dashboard: Dashboard
People People: People
Relationships: Relationships
Family Families: Family
Ancestry Charts: Charts
Events Events: Events
Places Places: Places
Geography Geography: Geography
Sources (v3.4.x) Sources: Sources (v3.4.x)
Citations Citations: Citations
Repositories Repositories: Repositories
Media Media: Media
Notes Notes: Notes
more of the standard icons

Text formatting (Level 2 Subsection)

italic, bold, bold & italic

Images (Level 3 Subsection)
Fig. .1 A screenshot caption

Logo

Annotations of User Activities (Level 4 Subsection)
  • Commands you type at the command line
  • Filenames or Filenames
  • Replaceable text
  • Labels for buttons and other portions of the graphical interface
  • Menu selections look like this: Menu -> Submenu -> Menu Item
  • Buttons you can click
  • CTRL+D see Keybindings for a list of keyboard combinations used in Gramps.
  • Anything you type in
  • Checked - Checkbox that is selected
  • Unchecked - Checkbox that is unselected

Boxed annotations

Tango-Dialog-information.png
Title of Tip

Tips text.

Gramps-notes.png
Example Note

Notes text.

Gnome-important.png
WarningTitle/Heading

warning text