Difference between revisions of "Write a "How Do I..." Article"

From Gramps
Jump to: navigation, search
m
m
Line 6: Line 6:
 
{{man note|''How do I...'' articles don't have to be pretty or professionally wtitten.|''They just need to make correct & useful information more accessible.'' <br /><br />Please be aware every public page may be edited by anyone. Each WikiContributor has pet projects to improve quality of pages... hotlinking, consistency of terminology, grammar, punctuation, order of presentation... all are likely to be changed. <br /><br />'''Don't take offense because none is intended'''. When someone edits your page, they are saying that they found value in what you wrote. Enough that it worth their time to pitch in. They might ''accidentally'' mess it up. If that happens, revert the content using the [https://meta.wikimedia.org/wiki/Special:MyLanguage/Help:Page_history History] and clarify what they misinterpreted.}}
 
{{man note|''How do I...'' articles don't have to be pretty or professionally wtitten.|''They just need to make correct & useful information more accessible.'' <br /><br />Please be aware every public page may be edited by anyone. Each WikiContributor has pet projects to improve quality of pages... hotlinking, consistency of terminology, grammar, punctuation, order of presentation... all are likely to be changed. <br /><br />'''Don't take offense because none is intended'''. When someone edits your page, they are saying that they found value in what you wrote. Enough that it worth their time to pitch in. They might ''accidentally'' mess it up. If that happens, revert the content using the [https://meta.wikimedia.org/wiki/Special:MyLanguage/Help:Page_history History] and clarify what they misinterpreted.}}
  
 +
==Build an fresh article==
 +
Creating a wiki page can be intimidating. But you do '''''not''''' have to start from scratch.
 +
 +
===Create a page===
 
The conventional suggestion for creating an expansion page on the wiki is to edit a page where the concept is only mentioned in passing and adding a 'link' to a term on the page. This is a good method if you've built the page offline and just want to paste in the [https://mediawiki.org/wiki/Help:Formatting MediaWiki markup language] code. But when using the MediaWiki editor to slowly build a page from scratch, it adds a dead link in a highly visible way.
 
The conventional suggestion for creating an expansion page on the wiki is to edit a page where the concept is only mentioned in passing and adding a 'link' to a term on the page. This is a good method if you've built the page offline and just want to paste in the [https://mediawiki.org/wiki/Help:Formatting MediaWiki markup language] code. But when using the MediaWiki editor to slowly build a page from scratch, it adds a dead link in a highly visible way.
  
 
You can create a Work-In-Progress page with a particular name by using the [https://mediawiki.org/wiki/Help:Searching Search box] in the left side bar. (The name is important because it determines how the content will be listed in the Category indices.) The search will try to list articles with all the terms entered. But if there isn't a phrase match for the title, the first option will also offer a red link at the top that would create a page.
 
You can create a Work-In-Progress page with a particular name by using the [https://mediawiki.org/wiki/Help:Searching Search box] in the left side bar. (The name is important because it determines how the content will be listed in the Category indices.) The search will try to list articles with all the terms entered. But if there isn't a phrase match for the title, the first option will also offer a red link at the top that would create a page.
  
 +
===Add "How Do I.." standard form===
 
Take advantage of the [[:Category:Templates|template]] for [[Template:How_do_I|How do I...]] to create a framework for the article. Use MediaWiki's [https://www.mediawiki.org/wiki/Transclusion subclusion] (''substitution [https://www.mediawiki.org/wiki/Transclusion transcribed inclusion]'')  feature by pasting the following line in the new document and saving it. The '''subst:''' before the template name will cause the content to be substituted into the editable workspace as the page is saved.  
 
Take advantage of the [[:Category:Templates|template]] for [[Template:How_do_I|How do I...]] to create a framework for the article. Use MediaWiki's [https://www.mediawiki.org/wiki/Transclusion subclusion] (''substitution [https://www.mediawiki.org/wiki/Transclusion transcribed inclusion]'')  feature by pasting the following line in the new document and saving it. The '''subst:''' before the template name will cause the content to be substituted into the editable workspace as the page is saved.  
  
The row of 4 tilde (&tilde;&tilde;&tilde;&tilde;) characters will add a datestamp line at the bottom with your hyperlinked WikiContributor name.  This adds the incomplete page to the page list generated when you click "[[Special:WhatLinksHere/Write_a_%22How_Do_I...%22_Article|What links here]]" in the left sidebar on your WikiContributor page. You can use this to make a work-in-progress (WIP) page list. When the page is complete enough to be made public & linked, remove the line to remove it from your EIP page list. (The '''Contributions''' link will still help you find the page but there would be more clutter.)
+
===Embed your user tag===
 +
The row of 4 tilde (&tilde;&tilde;&tilde;&tilde;) characters will add a datestamp line at the bottom with your hyperlinked {{userpage}} WikiContributor name.   
 +
 
 +
[[User:Bamaustin|Bamaustin]] ([[User talk:Bamaustin|talk]]) 17:51, 22 April 2020 (UTC)
 +
 
 +
This adds the incomplete page to the page list generated when you click "[[Special:WhatLinksHere/Write_a_%22How_Do_I...%22_Article|What links here]]" in the left sidebar on your WikiContributor page. You can use this to make a work-in-progress (WIP) page list. When the page is complete enough to be made public & linked, remove the line to remove it from your EIP page list. (The '''Contributions''' link will still help you find the page but there would be more clutter.)
 
<pre>
 
<pre>
 
{{subst:Template:How_do_I}}
 
{{subst:Template:How_do_I}}
Line 19: Line 29:
 
</pre>
 
</pre>
  
=== Possible Topics ===
+
== Possible Topics ==
 
&#x1F6A7;
 
&#x1F6A7;
 
* [[How to find the relationship between people|How do I find the relationship between people?]] ✔  
 
* [[How to find the relationship between people|How do I find the relationship between people?]] ✔  

Revision as of 17:51, 22 April 2020

How do I write a "How Do I..." Article

The "How Do I..." series of articles are designed to provide new users with some basic, step-by-step instructions on how to perform a specific task in Gramps. Articles should be targeted to users who are not familiar with Gramps, and may not be familiar to computing in general.

Gramps-notes.png
How do I... articles don't have to be pretty or professionally wtitten.

They just need to make correct & useful information more accessible.

Please be aware every public page may be edited by anyone. Each WikiContributor has pet projects to improve quality of pages... hotlinking, consistency of terminology, grammar, punctuation, order of presentation... all are likely to be changed.

Don't take offense because none is intended. When someone edits your page, they are saying that they found value in what you wrote. Enough that it worth their time to pitch in. They might accidentally mess it up. If that happens, revert the content using the History and clarify what they misinterpreted.

Build an fresh article

Creating a wiki page can be intimidating. But you do not have to start from scratch.

Create a page

The conventional suggestion for creating an expansion page on the wiki is to edit a page where the concept is only mentioned in passing and adding a 'link' to a term on the page. This is a good method if you've built the page offline and just want to paste in the MediaWiki markup language code. But when using the MediaWiki editor to slowly build a page from scratch, it adds a dead link in a highly visible way.

You can create a Work-In-Progress page with a particular name by using the Search box in the left side bar. (The name is important because it determines how the content will be listed in the Category indices.) The search will try to list articles with all the terms entered. But if there isn't a phrase match for the title, the first option will also offer a red link at the top that would create a page.

Add "How Do I.." standard form

Take advantage of the template for How do I... to create a framework for the article. Use MediaWiki's subclusion (substitution transcribed inclusion) feature by pasting the following line in the new document and saving it. The subst: before the template name will cause the content to be substituted into the editable workspace as the page is saved.

Embed your user tag

The row of 4 tilde (˜˜˜˜) characters will add a datestamp line at the bottom with your hyperlinked Template:Userpage WikiContributor name.

Bamaustin (talk) 17:51, 22 April 2020 (UTC)

This adds the incomplete page to the page list generated when you click "What links here" in the left sidebar on your WikiContributor page. You can use this to make a work-in-progress (WIP) page list. When the page is complete enough to be made public & linked, remove the line to remove it from your EIP page list. (The Contributions link will still help you find the page but there would be more clutter.)

{{subst:Template:How_do_I}}

~~~~

Possible Topics

🚧

  • How do I find the relationship between people?
  • How do I specify an adopted child or a step child?
  • How do I prevent private data from being displayed in reports?
  • How do I apply a filter to a display?
  • How do I handle multiple names for a single person?
  • How do I get help?
  • How do I report a bug?
  • How do I request a feature
  • How do I create a Familytree chart?