Help:Manual/References: Difference between revisions

MH370 DECODED
Jump to navigation Jump to search
No edit summary
No edit summary
 
(27 intermediate revisions by the same user not shown)
Line 1: Line 1:
<h2>References</h2>
<h2>References</h2>
<p>Updated 19 August 2024</p>
<div class="row">
  <div class="column-left col-width-40">
<h5>Abbreviations</h5>
<ul>
  <li><b>MS</b> - Media Statement</li>
  <li><b>RPT</b> - Report</li>
  <li><b>DOC</b> - Other type of Document</li>
  <li><b>MediaID-NNN</b> - Media articles</li>
  <li><b>IMG</b> - Image</li>
</ul>
  </div> <!-- end column left -->
  <div class="column-right col-width-60">
<h3>Code for a page citing a reference</h3>
<pre>
<p style="text-align:center;"><u>Source</u>: <i>Title</i> {{RefID:}}</p>
<br />
<p style="text-align:center;"><u>Source</u>: Name {{RefID:}}</p>
</pre>
  </div> <!-- end column right -->
</div> <!-- end row -->


<h3>1. Code on page in Reference/...  </h3>
<h3>1. Code on page in Reference/...  </h3>
<p>Note: The /Media refers to Media Statements.</p>
<pre>
<pre>
{{Template:Reference/Media
{{Template:Reference/Media <!--  -->
   |Anchor=<html><a class="offset" id=" "></a></html>
   |Anchor=<html><a class="offset" id=" "></a></html>
   |Ref-ID=
   |RefID=
   |Title=
   |Title=
   |Source=
   |Source=
Line 16: Line 36:
<p>
<p>
   <div style="margin-left: 5.5em; float: left;">Pages or articles which refer to this resource:-</div> <!-- end column 1  -->
   <div style="margin-left: 5.5em; float: left;">Pages or articles which refer to this resource:-</div> <!-- end column 1  -->
   <div class="displaytree"><categorytree mode="pages" depth="0" hideprefix="on"> </categorytree></div> <!-- Add Ref-ID -->
   <div class="displaytree"><categorytree mode="pages" depth="0" hideprefix="on"> </categorytree></div> <!-- Add RefID -->
   <div style="clear:left;">
   <div style="clear:left;"></div>
</p>
</p>
{{ShortLine}}
{{ShortLine}}
</pre>
</pre>


<h3>2. Code on page in Ref-ID: </h3>
<h3>2. Code on page in RefID: </h3>
<div class="row">
  <div class="column-left col-width-50">
<p>Note: Variable cannot be used for a RefID.</p>
<pre>
<pre>
{{ReferenceID
{{ReferenceID
<!-- Insert Ref-ID here:- -->
  |RefID=
   |Ref-ID=
  |Link=References/ #
<!-- Insert link here. Include the Ref-ID as an anchor # -->
}}
<noinclude>
  <p>{{RefID:{{PAGENAME}}/Description}}</p>
  <p>[[:Category:{{PAGENAME}}]]</p>
</noinclude>
</pre>
  </div> <!-- end column left -->
  <div class="column-right col-width-50">
<pre>
{{ReferenceID
<!-- Insert RefID here:- -->
   |RefID=
<!-- Insert link here. Include the RefID as an anchor # -->
   |Link=References/  #
   |Link=References/  #
}}
}}
<noinclude>
<noinclude>
<p>[[Ref-ID:{{PAGENAME}}/Description]]</p>
<p>{{RefID:{{PAGENAME}}/Description}}</p> <!-- add title -->
<p>{{Ref-ID:{{PAGENAME}}/Description}}</p> <!-- add title -->
{{ShortLine}}
{{ShortLine}}
<p>[[:Category:{{PAGENAME}}]]</p>
<p>[[:Category:{{PAGENAME}}]]</p>
</noinclude>
</noinclude>
</pre>
</pre>
  </div> <!-- end column right -->
</div> <!-- end row -->


<h3>3. Code on Category Page</h3>
<h3>3. Code on Category Page</h3>
<div class="row">
  <div class="column-left col-width-50">
<pre>
{{CategoryPage/RefID Header
  |RefID={{PAGENAME}}
  |Description={{RefID:{{PAGENAME}}/Description}}
  |ParentCategory=References
}}
</pre>
  </div> <!-- end column left -->
  <div class="column-right col-width-50">
<pre>
<pre>
{{CategoryPage/Ref-ID Header
{{CategoryPage/RefID Header
<!-- Add the Ref-ID. Defaults to {{PAGENAME}} -->
<!-- Add the RefID. Defaults to {{PAGENAME}} -->
   |Ref-ID=
   |RefID=
<!-- Transclude a description. Defaults to {{PAGENAME}}/Description -->
<!-- Transclude a description. Defaults to {{PAGENAME}}/Description -->
   |Description={{Ref: /Description}}
   |Description={{RefID: /Description}}
<!-- Specify a Parent Category. Defaults to References. -->
<!-- Specify a Parent Category. Defaults to References. -->
   |ParentCategory=References
   |ParentCategory=References
}}
}}
</pre>
</pre>
  </div> <!-- end column right -->
</div> <!-- end row -->
<hr>
<hr>


Line 61: Line 110:
   <li>When the Ref-ID is transcluded it contains a Category and a Link.</li>
   <li>When the Ref-ID is transcluded it contains a Category and a Link.</li>
   <li>The Category is Hidden. The Link is to an anchor on a reference index page.</li>
   <li>The Category is Hidden. The Link is to an anchor on a reference index page.</li>
   <li>The category has to be added manually 7if required within the Main namespace.</li>
   <li>The category has to be added manually if required within the Main namespace.</li>
  <li>Tooltips were started and abandoned. Tooltips do not work within links so the prefix Ref: had to be used for a the link. It is better to not quote the namespace and to use the whole Reference ID as the link.</li>
  <li>Jan 2025 simplified code to be copied on each page. Older code is usable, in columns on right.</li>
</ol>
</ol>
   </div> <!-- end column left -->
   </div> <!-- end column left -->
Line 72: Line 123:
   <li>The expression is part of the [[Template:ReferenceID]]</li>
   <li>The expression is part of the [[Template:ReferenceID]]</li>
</ol>
</ol>
 
  </div> <!-- end column right -->
 
</div> <!-- end row -->
 
 
 
 
 
 


<h5>Links</h5>
<h5>Links</h5>
Line 85: Line 130:
   <li>List of Media Sources and Abbreviations: [[References/Media/Sources]]</li>
   <li>List of Media Sources and Abbreviations: [[References/Media/Sources]]</li>
</ul>
</ul>
<h5>Sub-page List</h5>
<p>{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</p>
{{ShortLine}}
<ol>
  <li><p>From July 2023 all References are centralised in sub-pages of [[References|NS_Main:References]]. Note: Changed in Feb 2024.</p></li>
  <li><p>Each reference item is assigned a unique Reference-ID.</p></li>
  <li><p>Each Reference ID is created in the NS_Ref-ID: (alias Ref:).</p>
<p>For example: [[Ref-ID:ABCAU-021]]</p></li>
  <li><p>Each Reference-ID is composed of three parts:-</p>
<ul>
  <li>A prefix which identifies the source - organisation, government department, media agency etc.</li>
  <li>An abbreviation which describes the type of document:- MS = Media Statement; Rpt = Report; or Country Code</li>
  <li>A number to represent the date:- typically the Day Number.</li>
</ul>
<p>Each part uses upper case. And hyphens are used as separators.</p></li>
  <li><p>To create a new Reference ID use the sample code in [[Help:Manual/References/Code]].</p></li>
  <li><p>In a Reference/subpage use a template - see [[Template:Reference]].</p></li>
  <li><p>The Reference ID is used in two ways:-</p>
<ul>
  <li>The Reference-ID is written into the template used on a References/subpage where it becomes an anchor and also a link to a category page.</li>
  <li>The Reference-ID is transcluded to a Source: ... line at the end of each instance of usage. This provides a link to the anchor on the appropriate References/subpage.</li>
</ul>
</li>
</ol>
<h5>Links</h5>
<p>The type of link depends on the context:-</p>
<ul>
  <li>The Reference ID in NS_Ref-ID: is a link to the actual reference in a References/subpage#anchor.</li>
  <li>In a References/subpage the Reference ID is used as an anchor AND is used as a link to a Category
</ul>
<h5>Categories</h5>
<p>A Category is also created for each Reference-ID. Whenever the Source for a reference is used and the Reference ID is transcluded, the host page is automatically added to that category.</p>
<p>From the References/subpage clicking on the Reference-ID will open the Category page and list all the articles which use or refer to that Reference.</p>


<h5>Tooltips</h5>
<p>Tooltips were started and abandoned. Tooltips do not work within links so the prefix Ref: had to be used for a the link. It is better to not quote the namespace and to use the whole Reference ID as the link.</p>


{{ShortLine}}
{{ShortLine}}

Latest revision as of 03:51, 20 January 2025

References

Abbreviations
  • MS - Media Statement
  • RPT - Report
  • DOC - Other type of Document
  • MediaID-NNN - Media articles
  • IMG - Image

Code for a page citing a reference

<p style="text-align:center;"><u>Source</u>: <i>Title</i> {{RefID:}}</p>
<br />
<p style="text-align:center;"><u>Source</u>: Name {{RefID:}}</p>

1. Code on page in Reference/...

Note: The /Media refers to Media Statements.

{{Template:Reference/Media <!--  -->
   |Anchor=<html><a class="offset" id=" "></a></html>
   |RefID=
   |Title=
   |Source=
   |Date={{Day }}
   |URL1=<html><a href=" " target="_blank"> </a></html>
   |URL2=<html><a href=" " target="_blank"> </a></html>
   |URL3=<html><a href=" " target="_blank"> </a></html> <!-- Add a note instead of URL3 -->
}}
<p>
   <div style="margin-left: 5.5em; float: left;">Pages or articles which refer to this resource:-</div> <!-- end column 1  -->
   <div class="displaytree"><categorytree mode="pages" depth="0" hideprefix="on"> </categorytree></div> <!-- Add RefID -->
   <div style="clear:left;"></div>
</p>
{{ShortLine}}

2. Code on page in RefID:

Note: Variable cannot be used for a RefID.

{{ReferenceID
   |RefID=
   |Link=References/ #
}}
<noinclude>
   <p>{{RefID:{{PAGENAME}}/Description}}</p>
   <p>[[:Category:{{PAGENAME}}]]</p>
</noinclude>
{{ReferenceID
<!-- Insert RefID here:- -->
   |RefID=
<!-- Insert link here. Include the RefID as an anchor # -->
   |Link=References/  #
}}
<noinclude>
<p>{{RefID:{{PAGENAME}}/Description}}</p> <!-- add title -->
{{ShortLine}}
<p>[[:Category:{{PAGENAME}}]]</p>
</noinclude>

3. Code on Category Page

{{CategoryPage/RefID Header
   |RefID={{PAGENAME}}
   |Description={{RefID:{{PAGENAME}}/Description}}
   |ParentCategory=References
}}
{{CategoryPage/RefID Header
<!-- Add the RefID. Defaults to {{PAGENAME}} -->
   |RefID=
<!-- Transclude a description. Defaults to {{PAGENAME}}/Description -->
   |Description={{RefID: /Description}}
<!-- Specify a Parent Category. Defaults to References. -->
   |ParentCategory=References
}}

From 25 February 2024 the Reference system has been redesigned:-
  1. All information about a reference will be held in the Ref: namespace (alias Ref-ID:). The Page and sub-pages is like a record and fields.
  2. Each article in NS_Ref: will have multiple sub-pages, each containing part of the data, populate as required or if data is available
  3. The data, from relevant sub-pages, can be transcluded into a Reference Index
  4. Pages from the Reference Index may be transcluded into pages associated with the entity that published them
  5. When the Ref-ID is transcluded it contains a Category and a Link.
  6. The Category is Hidden. The Link is to an anchor on a reference index page.
  7. The category has to be added manually if required within the Main namespace.
  8. Tooltips were started and abandoned. Tooltips do not work within links so the prefix Ref: had to be used for a the link. It is better to not quote the namespace and to use the whole Reference ID as the link.
  9. Jan 2025 simplified code to be copied on each page. Older code is usable, in columns on right.
Categories
  1. The Ref-ID is also used as a Category Name
  2. Pages which include referenced content are in that Category
  3. To prevent non-public pages from also being in the Category, the code is conditional
  4. The expression is part of the Template:ReferenceID
Links