Editing User:Pharap/Wiki Improvement Proposals
From Guild of Archivists
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 2: | Line 2: | ||
=== Inline D'ni Dictionary Template === | === Inline D'ni Dictionary Template === | ||
==== Summary ==== | ==== Summary ==== | ||
Line 61: | Line 54: | ||
=== Apocrypha Banner === | === Apocrypha Banner === | ||
==== Summary ==== | ==== Summary ==== | ||
Line 88: | Line 74: | ||
| issue = is [[GoArch:Apocrypha|apocrypha]]. It should be considered [[GoArch:Canon policy|non-canon]] and may consist of fan-created content. | | 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}} }} | | small = {{#if:{{{sect|{{{section|{{{1|}}}}}}}}}|{{#if:{{{small|{{{left|}}}}}}|left}} }} | ||
| sect = | | sect = {{{1|}}} | ||
}} | }} | ||
Line 104: | Line 90: | ||
| issue = is [[GoArch:Apocrypha|apocrypha]]. It should be considered [[GoArch:Canon policy|non-canon]] and may consist of fan-created content. | | 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}} }} | | small = {{#if:{{{sect|{{{section|{{{1|}}}}}}}}}|{{#if:{{{small|{{{left|}}}}}}|left}} }} | ||
| sect = | | sect = {{{1|}}} | ||
}} | }} | ||
<noinclude> | <noinclude> | ||
Line 115: | Line 101: | ||
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}} === | ||
{{ | |||
| | |||
==== Summary ==== | ==== Summary ==== | ||
I propose | 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. | |||
==== Example ==== | ==== 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 | 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 ==== | ==== Implementation ==== | ||
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. | |||
=== IPA Hover Guides === | === IPA Hover Guides === | ||
==== Summary ==== | ==== Summary ==== | ||
Line 259: | Line 178: | ||
The whole thing would be wrapped in a <code>span</code> element with its <code>style</code> attribute set to produce a dotted line, and that would be bookended by forward slashes. | The whole thing would be wrapped in a <code>span</code> element with its <code>style</code> attribute set to produce a dotted line, and that would be bookended by forward slashes. | ||
=== | === Hover Text Template === | ||
==== Summary ==== | ==== Summary ==== | ||
I propose | I propose introducing a <code><nowiki>{{hover text}}</nowiki></code> template like [https://en.uesp.net/ UESP]'s <code><nowiki>{{</nowiki>[https://en.uesp.net/wiki/Template:Hover hover]<nowiki>}}</nowiki></code> template, which is itself based on Wikimedia's <code><nowiki>{{</nowiki>[https://meta.wikimedia.org/wiki/Template:H:title?useskin=vector H:title]<nowiki>}}</nowiki></code>. | ||
==== Reasoning ==== | ==== Reasoning ==== | ||
This new template would be useful for adding contextual information as a basic tooltip, and could be used as a base for building further, more complex templates. | |||
==== Example ==== | ==== Example ==== | ||
* <code><nowiki>{{Hover text|This is the hovertext|This is the main text}}</nowiki></code> → {{User:Pharap/Templates/Hover text|This is the hover text|This is the main text}} | |||
< | * <code><nowiki>{{Hover text|This is the hovertext|This is the main text|dotted=no}}</nowiki></code> → {{User:Pharap/Templates/Hover text|This is the hover text|This is the main text|dotted=no}} | ||
< | |||
</nowiki></ | ==== Implementation ==== | ||
The easiest way to impelement this would be with a <code>title</code> attribute on a <code>span</code> element. There may, however, be a better, more sophisticated, or more semantically correct way to implement the template. Fortunately, it can be amended after-the-fact if necessary. | |||
Additionally, the text would be underlined with a <span style="bottom-border: 1px dotted">dotted line</span> to highlight the fact the user can hover over it, and the cursor could be optionally changed to the <span style="cursor: help">help cursor</span>. | |||
By default, the first parameter would be the hover text and the second parameter would be the main text. A <code>dotted</code> parameter would be used to disable the dotted line. | |||
See <code><nowiki>{{</nowiki>[[User:Pharap/Templates/Hover text]]<nowiki>}}</nowiki></code> for a functional implementation. | |||
=== Abbreviation Template === | |||
==== Summary ==== | |||
This would function very much like the [[#Hover Template|aforementioned <code><nowiki>{{hover}}</nowiki></code> template]], but would instead rely on the <code><nowiki><abbr></nowiki></code> HTML element. | |||
< | |||
==== Reasoning ==== | |||
While the observable functionality is identical to <code><nowiki>{{hover}}</nowiki></code>, there would be a distinct semantic difference that may be of use to external tools, or perhaps to screenreaders. | |||
Note, from [https://developer.mozilla.org/en-US/docs/Web/HTML/Element/abbr#attributes Mozilla's documentation]: | |||
<blockquote> | |||
The title attribute has a specific semantic meaning when used with the <abbr> element; it must contain a full human-readable description or expansion of the abbreviation. This text is often presented by browsers as a tooltip when the mouse cursor is hovered over the element. | |||
</blockquote> | |||
==== Example ==== | |||
* Dictionary Abbreviations: | |||
** {{User:Pharap/Templates/Abbreviation|full=noun|abbreviation=n.}} | |||
** {{User:Pharap/Templates/Abbreviation|full=adjective|abbreviation=adj.}} | |||
** {{User:Pharap/Templates/Abbreviation|full=preposition|abbreviation=prep.}} | |||
** {{User:Pharap/Templates/Abbreviation|full=prefix|abbreviation=pre.}} | |||
** {{User:Pharap/Templates/Abbreviation|full=suffix|abbreviation=suf.}} | |||
==== Implementation ==== | |||
The implementation would use the <code><nowiki><abbr></nowiki></code> {{User:Pharap/Templates/Abbreviation|abbreviation=HTTP|full=HyperText Markup Language}} element and its <code>title</code> attribute. | |||
See <code><nowiki>{{</nowiki>[[User:Pharap/Templates/Abbreviation]]<nowiki>}}</nowiki></code> for a functional implementation. | |||
== Incomplete Proposals == | == Incomplete Proposals == | ||
* Further proposals for adding <code>quote</code> parameters to other <code>cite</code> templates, such as {{tlx|cite dialog}}. | * Further proposals for adding <code>quote</code> parameters to other <code>cite</code> templates, such as {{tlx|cite dialog}}. | ||
* Add an <code>access-date</code> parameter to the {{tlx|cite forum post}} template. | * Add an <code>access-date</code> parameter to the {{tlx|cite forum post}} template. | ||
* Add relevant details to <code>Reference:</code> pages that archive forum posts such that they can be properly cited with a {{tlx|cite forum post}}. In particular, the original forum post URL would be useful - the reference page should be considered the archived form if no [http://web.archive.org/ Wayback Machine] page exists. | * Add relevant details to <code>Reference:</code> pages that archive forum posts such that they can be properly cited with a {{tlx|cite forum post}}. In particular, the original forum post URL would be useful - the reference page should be considered the archived form if no [http://web.archive.org/ Wayback Machine] page exists. | ||
* | * 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 "Correct": 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. | ||
** | *** UESP also has the 'sic' link to an appropriate section of one of the style guide articles. For the Guild of Archivists, the most obvious candidate at the moment would be the [[GoArch:Style_guide#Quotations|Quotations]] section of the style guide. | ||
** | ** To provide a more concrete example, [[Reference:Gehn, Lab journal|Gehn's Lab Journal]] incorrectly says "discreet" instead of "discrete", and at present that looks like discreet {{sic|[discrete]}}. With the proposed change, it would appear as something more like <span title="Please do not attempt to correct this to "discrete". The original source is intentionally copied verbatim, including any and all typographical errors." style="border-bottom: 1px dotted">discreet ''<nowiki>[</nowiki>[[GoArch:Style_guide#Quotations|sic]]<nowiki>]</nowiki>''</span>, with the exact tooltip text being up for debate. | ||