User:FrozenPlum: Difference between revisions

From DynamicPageList3 Manual
Content added Content deleted
imported>FrozenPlum
imported>FrozenPlum
(A few updates to my list for when I have the time and energy to go back and do more (not right now, for now was just fixing things to make stuff usable in the meantime).)
 
(20 intermediate revisions by the same user not shown)
Line 1: Line 1:
This is not my wiki, I'm just a Miraheze user helping to get some content moved over. Feel free to reach me on my [[User talk:FrozenPlum|Talk]] page.
This is not my wiki, I'm just a Miraheze user helping to get some content moved over. Feel free to reach me on my [[User talk:FrozenPlum|Talk]] page.

==Taking breaks==
Hobby (slow) is about all I can manage, edit speed-wise.


==Self Reminders==
==Self Reminders==
* Still need to go through and check consistency, clarity, style etc for text and examples
* Some language or descriptions that aren’t quite right yet in examples.
* [[Controlling output volume]] has several temporary {{tl|hr}} sections until the heading colors for H4 are changed (I'd suggest the same size as H3 but maybe dark blue, or some other deeper color, just something that sets these apart better and gives a visual break to separate the subsections so they don't run together visually.


-------
* Still need to work though [[Special:WantedPages]] to fix or change any of these that should or should not be there.
* The pages for submitting a bug report, installing, getting extension (its MW page, github), giving feedback etc., are not here yet and where this all goes might get juggled around depending on UO's feedback.
* There probably should be a page explaining how to enable DPL3 on Miraheze (or linking to MH ManageWiki docs and at least saying what tab the extension is found in).
* Still '''need to add notes''' to areas where there's code but a non-working examples.

* '''Note:''' I still need to go back through to determine which templates/page (if any) require string functions to be enabled for Parser Functions extension. Once determined, should make sure it is also noted everywhere pertinent (some examples may rely on this, it is not default turned on at MH). See [[#Examples|Examples]] for more info.
* {{DPL|imagecontainer}} states that the required settings is <code>|openreferences=true</code>.
* {{DPL|linksfrom}} states to use <code>|openreferences=yes</code>.
* {{DPL|openreferences}} states the syntax is <code>|openreferences=yes</code>.
* <code>|openreferences=missing</code> that needs to be added to docs (later). It too currently kicks fatal error with imagecontainer, logged on GitHub.
* I'm tracking {{tl|note}} use at [[:Category:Development]].

==DPL3 Code Demos==
==DPL3 Code Demos==
I'm aware almost all use examples are currently broken, this is intentional until they can be replaced because this resource is in development. It is not ideal to have manual pages manifest inside the manual itself (this adds a level of unnecessary complexity for new users). Ideally, it would be optimal to have different example categories to draw from (e.g., fruit, pastries, cities, etc.) that are overly simple, and nearly impossible to confuse other site content. Some time is needed to determine a solid instructional plan for this, it will likely be similar to the examples used in the [[mw:Help:Tables#class="wikitable"|Help:Tables]] page to explain tables simply, on MediaWiki.org. It is best practice to begin with the simplest examples possible, to avoid ambiguity and any level of unnecessary complexity. This type of approach shifts the focus from the output to the learning at hand because the concepts used in the examples are highly intuitive and easily understood or ignored. It is best practice to use simple concepts in examples, and only add complexity of the learning itself (not the examples) as the complexity of the task increases. I need some time to think of a solid structure and organization for these "demo pages" (such as category:fruit, category:pastry category:city etc). Please be patient, until the examples are corrected, please use the [[wikia:Extension:DPL3/Manual|Gamepedia DPL3 Manual]].
On MediaWiki.org. It is best practice to begin with the simplest examples possible to avoid ambiguity and any level of unnecessary complexity. This type of approach shifts the focus from the output to the learning at hand because the concepts used in the examples are highly intuitive and easily understood enough to mostly be ignored. It is best practice to use simple concepts in examples, and only add complexity to the learning itself (not the examples) as the complexity of the task increases.


==Examples==
==Examples==
It would be good to have "more examples" '''links''' in-line, in each parameter's page section, that display a full selection of examples specific to a given parameter. Ideally, these should be named with parameter name first followed by "example" or "(Example)" (this allows examples to be quickly-skimmable from different entry points, like the [[Examples]] page, where it would make readers do less work to find what they want).
* Good to have "more examples" '''links''' in-line, in each parameter's page section, that display a full selection of examples specific to a given parameter? <s>Ideally, these should be named with parameter name first, followed by "example" or "(Example)"; this allows examples to be quickly-skimmable from different entry points</s> (there are practical reasons for this as-is). Different entry points, such as the [[Examples]] page and [[:Category:Examples|Examples]] category, will have different organization. <s>Having the key words at the beginning of each page title makes readers do less work (not having to read past "Example:_" every time, to find what they want (they can ignore the word "Example/example" if placed at the end</s> (while I don't love titles like "Parameter:_category" because it mimics a namespace, and if a "Parameters" namespace is created the blank space at the beginning will be removed and parameter name changed to title case, this is the only feasible way to have lowercase parameter names to avoid ambiguity, despite the unorthodox approach).</s>


The logic is to cater to different audiences and '''entry points''' to the information:
The logic to rejigging the examples, is to cater to different audiences and '''entry points''' to the information:
# '''Comprehensive''' – Audience: Average or infrequent visitors, needing to re-read parameter sections – Examples still say in-line, just also linking to "more examples" for a larger selection of and different use cases/examples for that parameter.
# '''Comprehensive''' – Audience: Average or ''infrequent'' visitors, needing to re-read parameter sections – Basic examples still stay in-line, but each parameter section links to a "more examples" page, for a larger selection of different use cases/examples for the given parameter.
# '''Task-based''' – Audience: Moderate to advanced and/or frequent visitors, ''already'' having read the parameter sections. – Allows a fast starting point/reference, or quick copy/paste of example code to adapt, without having to sift though the longer pages or their TOCs (A problem with the current Gamepedia DPL3 Manual).
# '''Task-based''' – Audience: Moderate to advanced and/or ''frequent'' visitors, ''already'' having read the parameter sections. – Allows a fast starting point, or quick copy/paste of example code to adapt, without having to sift though long pages/TOCs (a problem with the current Gamepedia DPL3 Manual).


Individual examples for "More Examples" ''may'' need their own pages, so they can be categorized by parameter use, and then transcluded or DPL3 included, into the other pages mentioned ^ above. I'm still thinking about a system of sorts for this, it may take some time to hatch a solid plan.
An idea (that might not work), is that individual examples from "More Examples" ''may'' need their own pages, so they can be categorized by parameter use. If categorized by parameter use, these can be transcluded into the other pages mentioned ^ above. I'm still thinking about a system of sorts (and if this is even feasible) for this, it may take some time. Ideally, (also may not be feasible) I'd like a way to get each bit of code to go into a sandbox, with preloaded text, for someone to try manipulating.


From [[mw:Manual:Creating pages with preloaded text#Loading the preload file|Creating pages with preloaded text]] for sandbox test links, from example pages. "default=Special:Mypage/parametername test" loads "User:Username/parametername test" (a reminder that if already existing, the preload won't work, and to enter a distinct name other than "test" might work.
The DPL2 site had an ''Examples'' category, but the examples had generic names like "Example 002" which made the task-based approach not feasible because you'd either have to click every one, or had to sift though manual sections like the Gamepedia Manual currently. Also, too many in-line examlpes can cause issues. Some titles are a little strange, like "Example:_Display_images_used" but that type of categorization and/or page might be a good idea for when users want to see different ways to display images! '''Relevant examples, to the task at hand, just need to be ''way'' easier to find,''' which is why I'd need some time to think about approaching this systematically.


<pre>
===Templates using Variables and Loops==
<inputbox>
The following use Variables (also some use Loops, plus string functions enabled in ManageWiki for parser functions), which will perhaps need simplification and replacement later:
type=comment
default=Special:Mypage/inputbox test
type=create
preload=Log
</inputbox>
</pre>

The DPL2 site had an ''Examples'' category, but the examples had generic names like "Example 002" which made the task-based approach not feasible because you'd either have to click every one, or had to sift though manual sections like the Gamepedia Manual currently. Also, too many in-line examlpes can cause issues. Some titles are a little strange, like "Example:_Display_images_used" but that type of categorization and/or page might be a good idea for when users want to see different ways to display images! '''Relevant examples, to the task at hand, just need to be ''way'' easier to find,''' which is why I'd need some time to think about approaching this systematically.


==Templates using Variables and Loops==
# {{tl|DPL parameter}} – for linking to a parameter (also linked to current DPL syntax template, where the global vars are declared).
The following were found to use other extensions, see [[:Category:Templates to simplify or eliminate]] for which uses which. Variables extension's future is uncertain, so these templates may need to be simplified, adjusted, or eliminated:
# {{tl|DPL syntax}} – for displaying variations on <code>mode=<i>modename</i></code>
#* Am considering replacing with <code><nowiki>{{syntax|text{{=}}value}}</nowiki></code>
# {{tl|And}} – Possibly never would have found this if I hadn't been going through pages and templates individually... since there appears to be no tracking categories for some extensions.
# {{tl|Key}} - Not sure this template complexity is really necessary at all.


{{#dpl:
<!--{{dpl3|count}}-->
|category=Templates to simplify or eliminate
|count=100
}}


'''Note:''' I still need to go back through to determine which requires string functions to be enabled for Parser Functions extension. Once determined, should make sure it is also noted where pertinent.
<!--
* [[mw:Extension:StringFunctions#Functions|Merged]] with string functions and need it enabled:
<includeonly><span id="{{{1|}}}">{{{2|}}}</span></includeonly><noinclude>
::len, pos, rpos, sub, replace, explode
<templatedata>
* [[mw:Extension:StringFunctions#Functions|Not merged]], need to make sure not used:
{
::pad, urlencode, and urldecode
"params": {
"1": {
"label": "Anchor Text (must be lowercase!)",
"description": "Enter anchor text (all lowercase)",
"type": "string",
"default": "purple",
"required": true
},
"2": {
"label": "Text to display beside anchor (optional)",
"description": "Enter the word or words to anchor to, note that spaces must be replaced by underscores, though dashes and colons can be used.",
"example": "mode",
"type": "string"
}
},
"description": "Creates a span with an ID to be used as a bookmark/named anchor by wrapping the content in a span with an id whose anchor text is whatever you set it to be. Then, you can link to it by using Pagename#anchorname\". Note: Anchor text is intentionally lowercase so it can never clash with existing Mediawiki anchors (TOC) which always start with an uppercase letter. "
}
</templatedata>
[[Category:Technical templates]]
</noinclude>
-->

Latest revision as of 19:54, 15 June 2023

This is not my wiki, I'm just a Miraheze user helping to get some content moved over. Feel free to reach me on my Talk page.

Taking breaks

Hobby (slow) is about all I can manage, edit speed-wise.

Self Reminders

  • Still need to go through and check consistency, clarity, style etc for text and examples
  • Some language or descriptions that aren’t quite right yet in examples.
  • Controlling output volume has several temporary {{hr}} sections until the heading colors for H4 are changed (I'd suggest the same size as H3 but maybe dark blue, or some other deeper color, just something that sets these apart better and gives a visual break to separate the subsections so they don't run together visually.



  • Still need to work though Special:WantedPages to fix or change any of these that should or should not be there.
  • The pages for submitting a bug report, installing, getting extension (its MW page, github), giving feedback etc., are not here yet and where this all goes might get juggled around depending on UO's feedback.
  • There probably should be a page explaining how to enable DPL3 on Miraheze (or linking to MH ManageWiki docs and at least saying what tab the extension is found in).
  • Still need to add notes to areas where there's code but a non-working examples.
  • Note: I still need to go back through to determine which templates/page (if any) require string functions to be enabled for Parser Functions extension. Once determined, should make sure it is also noted everywhere pertinent (some examples may rely on this, it is not default turned on at MH). See Examples for more info.
  • imagecontainer states that the required settings is |openreferences=true.
  • linksfrom states to use |openreferences=yes.
  • openreferences states the syntax is |openreferences=yes.
  • |openreferences=missing that needs to be added to docs (later). It too currently kicks fatal error with imagecontainer, logged on GitHub.
  • I'm tracking {{note}} use at Category:Development.

DPL3 Code Demos

On MediaWiki.org. It is best practice to begin with the simplest examples possible to avoid ambiguity and any level of unnecessary complexity. This type of approach shifts the focus from the output to the learning at hand because the concepts used in the examples are highly intuitive and easily understood enough to mostly be ignored. It is best practice to use simple concepts in examples, and only add complexity to the learning itself (not the examples) as the complexity of the task increases.

Examples

  • Good to have "more examples" links in-line, in each parameter's page section, that display a full selection of examples specific to a given parameter? Ideally, these should be named with parameter name first, followed by "example" or "(Example)"; this allows examples to be quickly-skimmable from different entry points (there are practical reasons for this as-is). Different entry points, such as the Examples page and Examples category, will have different organization. Having the key words at the beginning of each page title makes readers do less work (not having to read past "Example:_" every time, to find what they want (they can ignore the word "Example/example" if placed at the end (while I don't love titles like "Parameter:_category" because it mimics a namespace, and if a "Parameters" namespace is created the blank space at the beginning will be removed and parameter name changed to title case, this is the only feasible way to have lowercase parameter names to avoid ambiguity, despite the unorthodox approach).

The logic to rejigging the examples, is to cater to different audiences and entry points to the information:

  1. Comprehensive – Audience: Average or infrequent visitors, needing to re-read parameter sections – Basic examples still stay in-line, but each parameter section links to a "more examples" page, for a larger selection of different use cases/examples for the given parameter.
  2. Task-based – Audience: Moderate to advanced and/or frequent visitors, already having read the parameter sections. – Allows a fast starting point, or quick copy/paste of example code to adapt, without having to sift though long pages/TOCs (a problem with the current Gamepedia DPL3 Manual).

An idea (that might not work), is that individual examples from "More Examples" may need their own pages, so they can be categorized by parameter use. If categorized by parameter use, these can be transcluded into the other pages mentioned ^ above. I'm still thinking about a system of sorts (and if this is even feasible) for this, it may take some time. Ideally, (also may not be feasible) I'd like a way to get each bit of code to go into a sandbox, with preloaded text, for someone to try manipulating.

From Creating pages with preloaded text for sandbox test links, from example pages. "default=Special:Mypage/parametername test" loads "User:Username/parametername test" (a reminder that if already existing, the preload won't work, and to enter a distinct name other than "test" might work.

<inputbox>
type=comment
default=Special:Mypage/inputbox test
type=create
preload=Log
</inputbox>

The DPL2 site had an Examples category, but the examples had generic names like "Example 002" which made the task-based approach not feasible because you'd either have to click every one, or had to sift though manual sections like the Gamepedia Manual currently. Also, too many in-line examlpes can cause issues. Some titles are a little strange, like "Example:_Display_images_used" but that type of categorization and/or page might be a good idea for when users want to see different ways to display images! Relevant examples, to the task at hand, just need to be way easier to find, which is why I'd need some time to think about approaching this systematically.

Templates using Variables and Loops

The following were found to use other extensions, see Category:Templates to simplify or eliminate for which uses which. Variables extension's future is uncertain, so these templates may need to be simplified, adjusted, or eliminated:

{{#dpl: |category=Templates to simplify or eliminate |count=100 }}

Note: I still need to go back through to determine which requires string functions to be enabled for Parser Functions extension. Once determined, should make sure it is also noted where pertinent.

  • Merged with string functions and need it enabled:
len, pos, rpos, sub, replace, explode
pad, urlencode, and urldecode