Difference between revisions of "CreationKit:Community Portal/Organization"
CreationKit:Community Portal/Organization (edit)
Revision as of 10:59, 21 February 2012
, 10:59, 21 February 2012→Snippets: new section
imported>Dragoonwraith |
imported>Qazaaq (→Snippets: new section) |
||
| Line 170: | Line 170: | ||
:::You can "rename" anything by Moving it. Moving will keep its associated history, and set up a redirect (which works as hoped for with Templates). | :::You can "rename" anything by Moving it. Moving will keep its associated history, and set up a redirect (which works as hoped for with Templates). | ||
:::[[User:Dragoonwraith|<span style="font-family: Oblivion; size=2;">D</span>ragoon <span style="font-family: Oblivion; size=2;">W</span>raith]] [[User_talk:Dragoonwraith|<span style="font-family: Oblivion; size=2;">TALK</span>]] 09:25, 20 February 2012 (EST) | :::[[User:Dragoonwraith|<span style="font-family: Oblivion; size=2;">D</span>ragoon <span style="font-family: Oblivion; size=2;">W</span>raith]] [[User_talk:Dragoonwraith|<span style="font-family: Oblivion; size=2;">TALK</span>]] 09:25, 20 February 2012 (EST) | ||
== Snippets == | |||
There are quite a few pieces of information on the wiki that could be used in multiple places. Examples of this are hotkeys and the summary of a script function. I'm going to call these pieces snippets. | |||
Snippets are ideally defined only once. That allows us to make changes more quickly, and it makes it easier to keep the information accurate. | |||
The ideal place to define a snippet is on the page that also contains the detailed information on that topic. This means the following for our examples. The summary/definition of a function can be defined under its own heading on the script function's own page. Controls can be defined on a separate page listing all controls available for a specific window. | |||
Applying snippets can be done by transcluding the page (note, this is not necessarily a template) with the snippet into the page where the snippet should be displayed. For this page containing the snippet should be setup with <tt><nowiki><includeonly></nowiki></tt>, <tt><nowiki><noinclude></nowiki></tt> and <tt><nowiki><onlyinclude></nowiki></tt>-tags to only display the snippet after transclusion. | |||
A problem arises when more than one snippet needs to be defined on the same page. For example a controls page could have different snippets with sets of controls for different tasks. There are two viable options here: | |||
; Snippets on subpages | |||
: This allows us to keep the snippets related to the page they belong to. Ideally all subpaged snippets are used in the article they belong to. | |||
; Snippets on templates | |||
: This allows us to keep the snippets | |||
===Keeping track of snippets=== | |||
I have identified the following options for tracking snippets: | |||
; Snippet category | |||
: Keeping all snippets in a snippet category. Note that only complete pages can be added to a category. This means not a snippet is added to the category, but the article containing it. This is not an issue if all snippets are defined on their own page. | |||
; Manual listing of all snippets | |||
: This method works unrelated to where the snippets are defined. | |||
''Unfinished'' | |||