User:Pharap: Difference between revisions

From Guild of Archivists
m (Rectify formatting.)
(Refactor 'Planned Proposals' section into 'Proposals' section with more formal, more complete proposals, and a section to note currently unformulated but planned proposals at the bottom..)
Line 9: Line 9:
* [https://forum.guildofwriters.org/memberlist.php?mode=viewprofile&u=10547 Guild of Writers Profile]
* [https://forum.guildofwriters.org/memberlist.php?mode=viewprofile&u=10547 Guild of Writers Profile]


== Planned Proposals ==
== Wiki Improvement Proposals ==


Things that I intend to propose when I find a suitable place to propose them and have a moment to state my case:
=== Template Improvement Proposals ===


* Propose the addition of a <code>quote</code> parameter to various <code>cite</code> templates, including <code>cite dialog</code>, <code>cite book</code>, and <code>cite forum post</code>.
==== Apocrypha Banner ====
** Specifically, such citations would include an optional <code>quote</code> parameter that could include a relevant exerpt from the cited resource to better illustrate specifically which part of the resource is relevant to the cited claim.
 
*** E.g. the [[Esher]] article uses a <code><nowiki>{{cite dialog}}</nowiki></code> template to cite [[Reference:2007-11-05 Yeesha and the bahro in K'veer|Yeesha's 2007-11-05 cavern speech]] and provides a timestamp (19:17:37) for the specific quote. Rather than having to hunt through the chatlog to find the corresponding timestamped quote, the relevant quote itself could be included as part of the template and thus show up in the <code><nowiki>{{reflist}}</nowiki></code>. I.e. rather than <code>Yeesha. 2007-11-05 Yeesha and the bahro in K'veer [19:17:37]. Uru Live.</code>, the reference could be: <code>"He is missing a large patch of skin on his shoulder - taken from him in the tortuous lab of Esher." Yeesha. 2007-11-05 Yeesha and the bahro in K'veer [19:17:37]. Uru Live.</code>, which would be more useful for readers checking references.
===== Summary =====
*** Including a quote parameter for book citations would allow lines from the book series to be quoted as proof of evidence/relevance without requiring the whole book text to be archived.
 
*** Including a quote parameter for forum posts would allow specific relevant lines from a potentially long forum post to be quoted, thus highlighting the specific relevant information for ease of verification.
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.
* Propose differentiating [[GoArch:Apocrypha|apocrypha]] with a large banner as is done with [[GoArch:Unexplored Branches|Unexplored Branches]] articles (e.g. [[Chiso Preniv]]), as opposed to the current method of using a small, unobvious badge.
 
** Hopefully the reasoning for this is obvious: to make apocrypha articles more obvious and less likely to be mistaken for 'official' content.
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 =====
 
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 {{tlx|apocrypha}} template would appear as thus:
 
{{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|}}}
}}
 
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 {{tlx|ambox}} template.
 
<pre><nowiki>
<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>
</nowiki></pre>
 
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.
 
==== Adding a <code>quote</code> Parameter to {{tlx|cite journal}} ====
 
===== 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.
 
===== 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 <code>quote</code> parameter could then be used as thus:
<pre><nowiki>
<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>
</nowiki></pre>
 
Producing an output of:
<blockquote><samp>Catherine, ''Personal journal''. Riven. "They have named it "Tay""</samp></blockquote>
 
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 <code><nowiki>{{#if:{{{quote|}}}| "{{{quote}}}"|}}</nowiki></code> to the existing template, such that it becomes:
 
<pre><nowiki>
{{{author}}}. ''{{{journal-nolink|[[{{{journal-page|Reference:{{{author}}}, {{{journal}}}}}}|{{{journal}}}]]}}}''. {{{game-nolink|[[{{{game-page|{{{game}}}}}}|{{{game}}}]]}}}.{{#if:{{{quote|}}}| "{{{quote}}}"|}}<noinclude>{{documentation}}</noinclude>
</nowiki></pre>
 
The documentation for the template could be ammended with:
 
<pre><nowiki>
"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"
}
</nowiki></pre>
 
As well as the addition of <code>"quote"</code> to the end of the <code>paramOrder</code> 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.
 
=== Incomplete Proposals ===
 
* Further proposals for adding <code>quote</code> parameters to other <code>cite</code> templates, such as {{tlx|cite dialog}}.
* Adapting the {{tlx|sic}} template to produce an output more akin to what [https://en.uesp.net/wiki/Main_Page UESP] produces. (A surplus of examples can be found in the [https://en.uesp.net/wiki/Bloodmoon:Airship_Captain%27s_Journal Bloodmoon:Airship Captain's Journal] article.
** For those who are unwilling or unable to visit the linked page, if one were to use UESP's <nowiki>{{sic}}</nowiki> template as <nowiki>{{sic|Incorrect|Correct}}</nowiki>, that would cause the text to appear as thus: <span title="Please do NOT CHANGE to &quot;Correct&quot;: the original source is intentionally copied and has the error." style="border-bottom:1px dotted">Incorrect ''[sic]''</span>. Naturally the text in the hover box could be adapted to say whatever might be appropriate. It could be as simple as including only the correct text.

Revision as of 11:23, 20 December 2023

Summary

IPA: /ˈfɛː.ɹæp/

D'ni (approximation): feråp

Links

Wiki Improvement Proposals

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.

Adding 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.

Incomplete Proposals

  • Further proposals for adding quote parameters to other cite templates, such as {{cite dialog}}.
  • Adapting the {{sic}} template to produce an output more akin to what UESP produces. (A surplus of examples can be found in the Bloodmoon:Airship Captain's Journal article.
    • For those who are unwilling or unable to visit the linked page, if one were to use UESP's {{sic}} template as {{sic|Incorrect|Correct}}, that would cause the text to appear as thus: Incorrect [sic]. Naturally the text in the hover box could be adapted to say whatever might be appropriate. It could be as simple as including only the correct text.