User:Pharap/Wiki Improvement Proposals: Difference between revisions

From Guild of Archivists
(Create 'Wiki Improvement Proposals' subpage.)
 
(Rectify heading levels.)
Line 1: Line 1:
== Wiki Improvement Proposals ==
== Template Improvement Proposals ==


=== Template Improvement Proposals ===
=== Apocrypha Banner ===


==== Apocrypha Banner ====
==== Summary ====
 
===== Summary =====


At the moment, [[GoArch:Apocrypha|apocrypha]] articles using the {{tlx|apocrypha}} template are marked with a small badge at the top right of the page which is unobvious and easily overlooked.
At the moment, [[GoArch:Apocrypha|apocrypha]] articles using the {{tlx|apocrypha}} template are marked with a small badge at the top right of the page which is unobvious and easily overlooked.
Line 11: Line 9:
I propose that instead of (or in addition to) a small badge, apocrypha articles be marked with a large banner at the top of the page as is done with both Out-of-Cavern artices (e.g. [[Riven (game)]]) via the {{tlx|OOC}} tag and [[GoArch:Unexplored Branches|Unexplored Branches]] articles (e.g. [[Chiso Preniv]]) via the {{tlx|Unexplored Branches}} tag.
I propose that instead of (or in addition to) a small badge, apocrypha articles be marked with a large banner at the top of the page as is done with both Out-of-Cavern artices (e.g. [[Riven (game)]]) via the {{tlx|OOC}} tag and [[GoArch:Unexplored Branches|Unexplored Branches]] articles (e.g. [[Chiso Preniv]]) via the {{tlx|Unexplored Branches}} tag.


===== Reasoning =====
==== Reasoning ====


The reasoning behind this suggestion is to make apocrypha articles more obvious and less likely to be mistaken for 'official' content, particularly in cases where particularly well-made apocrypha with similar quality and/or appearance to official content might easily be mistaken for official content if one has overlooked the badge.
The reasoning behind this suggestion is to make apocrypha articles more obvious and less likely to be mistaken for 'official' content, particularly in cases where particularly well-made apocrypha with similar quality and/or appearance to official content might easily be mistaken for official content if one has overlooked the badge.


===== Example =====
==== Example ====


The banner by including the {{tlx|apocrypha}} template would appear as thus:
The banner by including the {{tlx|apocrypha}} template would appear as thus:
Line 29: Line 27:
The badge on the top right of the page could appear as it currently does or be omitted.
The badge on the top right of the page could appear as it currently does or be omitted.


===== Implementation Details =====
==== Implementation Details ====


The change could be enacted by the use of an {{tlx|ambox}} template.
The change could be enacted by the use of an {{tlx|ambox}} template.
Line 51: Line 49:
This template currently includes no documentation, though if any were needed it should simply be a matter of adapting the documentation provided for the {{tlx|OOC}} or {{tlx|Unexplored Branches}} templates.
This template currently includes no documentation, though if any were needed it should simply be a matter of adapting the documentation provided for the {{tlx|OOC}} or {{tlx|Unexplored Branches}} templates.


==== Add a <code>quote</code> Parameter to {{tlx|cite journal}} ====
=== Add a <code>quote</code> Parameter to {{tlx|cite journal}} ===


===== Summary =====
==== Summary ====


I propose to add a <code>quote</code> parameter to the {{tlx|cite journal}} template so that references may include specific quotes relevant to the claim being supported by the citation.
I propose to add a <code>quote</code> parameter to the {{tlx|cite journal}} template so that references may include specific quotes relevant to the claim being supported by the citation.


===== Reasoning =====
==== Reasoning ====


The intent of such a quotation would be to make it easier to verify claims as readers would not have to (for example) go hunting through entire journals just to find the one sentence that supports the claim made in the article.
The intent of such a quotation would be to make it easier to verify claims as readers would not have to (for example) go hunting through entire journals just to find the one sentence that supports the claim made in the article.


===== Example =====
==== Example ====


The <code>quote</code> parameter could then be used as thus:
The <code>quote</code> parameter could then be used as thus:
Line 75: Line 73:
Should anyone find the nesting of the same style of quotes unsatisfactory, I ''believe'' it should be possible to enforce the inner quotes being made a different style.
Should anyone find the nesting of the same style of quotes unsatisfactory, I ''believe'' it should be possible to enforce the inner quotes being made a different style.


===== Implementation Details =====
==== Implementation Details ====


This proposal could be implemented by simply adding <code><nowiki>{{#if:{{{quote|}}}| "{{{quote}}}"|}}</nowiki></code> to the existing template, such that it becomes:
This proposal could be implemented by simply adding <code><nowiki>{{#if:{{{quote|}}}| "{{{quote}}}"|}}</nowiki></code> to the existing template, such that it becomes:

Revision as of 19:09, 20 December 2023

Template Improvement Proposals

Apocrypha Banner

Summary

At the moment, apocrypha articles using the {{apocrypha}} template are marked with a small badge at the top right of the page which is unobvious and easily overlooked.

I propose that instead of (or in addition to) a small badge, apocrypha articles be marked with a large banner at the top of the page as is done with both Out-of-Cavern artices (e.g. Riven (game)) via the {{OOC}} tag and Unexplored Branches articles (e.g. Chiso Preniv) via the {{Unexplored Branches}} tag.

Reasoning

The reasoning behind this suggestion is to make apocrypha articles more obvious and less likely to be mistaken for 'official' content, particularly in cases where particularly well-made apocrypha with similar quality and/or appearance to official content might easily be mistaken for official content if one has overlooked the badge.

Example

The banner by including the {{apocrypha}} template would appear as thus:

The badge on the top right of the page could appear as it currently does or be omitted.

Implementation Details

The change could be enacted by the use of an {{ambox}} template.

<indicator name="apocrypha">[[File:Apocrypha.png|30px|link=GoArch:Apocrypha]]</indicator><includeonly>[[Category:Apocrypha]]</includeonly>
{{ambox
| type=notice
| image=[[File:Apocrypha.png|50px]]
| issue = is [[GoArch:Apocrypha|apocrypha]]. It should be considered [[GoArch:Canon policy|non-canon]] and may consist of fan-created content.
| small = {{#if:{{{sect|{{{section|{{{1|}}}}}}}}}|{{#if:{{{small|{{{left|}}}}}}|left}} }}
| sect = {{{1|}}}
}}
<noinclude>
'''This template is for indicating that an article is about a non-canon subject. Non-canon subjects include:
* Fan-created content, such as the [[Lara Documents]] or fan-created Ages
* Material from the Dark Horse comics
* Ret-conned content from the Myst novels (such as [[Tadjinar]])</noinclude>

This template currently includes no documentation, though if any were needed it should simply be a matter of adapting the documentation provided for the {{OOC}} or {{Unexplored Branches}} templates.

Add a quote Parameter to {{cite journal}}

Summary

I propose to add a quote parameter to the {{cite journal}} template so that references may include specific quotes relevant to the claim being supported by the citation.

Reasoning

The intent of such a quotation would be to make it easier to verify claims as readers would not have to (for example) go hunting through entire journals just to find the one sentence that supports the claim made in the article.

Example

The quote parameter could then be used as thus:

<ref name="Tay">{{cite journal|author=Catherine|journal=Personal journal|journal-page=Reference:Catherine, personal journal (Riven)|game=Riven|quote=They have named it "Tay"}}</ref>

Producing an output of:

Catherine, Personal journal. Riven. "They have named it "Tay""

The presence or absence of quote marks and/or the style of the quote marks would be up for discussion.

Should anyone find the nesting of the same style of quotes unsatisfactory, I believe it should be possible to enforce the inner quotes being made a different style.

Implementation Details

This proposal could be implemented by simply adding {{#if:{{{quote|}}}| "{{{quote}}}"|}} to the existing template, such that it becomes:

{{{author}}}. ''{{{journal-nolink|[[{{{journal-page|Reference:{{{author}}}, {{{journal}}}}}}|{{{journal}}}]]}}}''. {{{game-nolink|[[{{{game-page|{{{game}}}}}}|{{{game}}}]]}}}.{{#if:{{{quote|}}}| "{{{quote}}}"|}}<noinclude>{{documentation}}</noinclude>

The documentation for the template could be ammended with:

"quote":
{
	"label": "Quote",
	"description": "A selected quote from the referenced journal. The chosen quote should be relevant to the article content that makes use of the citation. If omitted, no quote is included in the reference.",
	"example": "They have named it \"Tay\"",
	"type": "string"
}

As well as the addition of "quote" to the end of the paramOrder array.

Note: In regards to enforcing that nested quotes use a different style, I don't believe templates alone are capable of text replacement that sophisticated, though it's possible they support some sort of regex-replacement feature that I'm unaware of at the time of writing. To support such a feature would, I believe, require a Lua module. I haven't researched that as I'm presuming it won't be an issue, but should it be an issue I have sufficient experience with Lua and parsing that I'm confident I could make a good go of it.