icons:conventions

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
icons:conventions [2023/02/20 15:42] – fix conventions links suedunhamicons:conventions [2023/02/23 11:26] (current) – ↷ Links adapted because of a move operation suedunham
Line 1: Line 1:
 ====== Works icons conventions ====== ====== Works icons conventions ======
  
-These conventions guide the use of icons in the ''works:'' section of the wiki. There are two primary ways they are used.+These conventions guide the use of icons in the ''works:'' section of the wiki. When discussing these works we use some common and synonymous words to mean specific, different things.
  
-  - In [[:wiki:navigation_pages#works_right_sidebars|rightsidebar lists]] and [[:wiki:refnotes_plugin|RefNotes citations]], an icon precedes the link to signify the broad category to which the work belongs among the following. These are plain icons in this case, and only one is used.+  * **Class** refers to whether the work is canon---produced by the game publishers---or fanon---produced by fans. 
 +  * **Category** refers to a group into which similar works can be grouped by subject matter. These are things like Adventures, Kaldor, HârnMaster, etc. 
 + 
 +===== Two ways icons are used ===== 
 + 
 +  - In [[:wiki:navigation pages#works right sidebars|rightsidebar lists]] and [[:wiki:refnotes plugin|RefNotes citations]], an icon precedes the link to signify the broad class to which the work belongs among the following. These are plain icons in this case, and only one is used.
     - **Canon works** have a checkbox     - **Canon works** have a checkbox
     - **Fanon works** have a fan     - **Fanon works** have a fan
     - **Out-of-print works** have a gravestone     - **Out-of-print works** have a gravestone
-  - Above the top-level headings on the pages for each work, a row of icons appears that have all been formatted with a background color and border resembling the page headers of articles by [[:works:publishers:cgi]] These represent a finer subject categorization of the type of material the work contains, which in turn is aligned with the sub-namespaces into which the ''works:'' namespace of the wiki is divided.+  - Above the top-level headings on the pages for each work, a row of icons appears that have all been formatted with a background color and border resembling the page headers of articles by [[:works:publishers:cgi]] These represent the category to which the work belongs, which in turn is aligned with the sub-namespaces into which the ''works:'' namespace of the wiki is divided.
  
-===== Listing icons =====+==== Listing icons ====
  
 Conventions for listings are straightforward: each work gets one icon from a choice of three. The [[wiki:icons_plugin]] is used to display it as follows. Conventions for listings are straightforward: each work gets one icon from a choice of three. The [[wiki:icons_plugin]] is used to display it as follows.
  
-^ Category ^ Example ^ Code ^+^ Class ^ Example ^ Code ^
 | Canon works | {{mdi>checkbox-marked?size=12}} [[:works:harn:kaldor:kaldor]] | ''%%{{mdi>checkbox-marked?size=12}} [[:works:harn:kaldor:kaldor]]%%'' | | Canon works | {{mdi>checkbox-marked?size=12}} [[:works:harn:kaldor:kaldor]] | ''%%{{mdi>checkbox-marked?size=12}} [[:works:harn:kaldor:kaldor]]%%'' |
 | Fanon works | {{mdi>fan?size=12}} [[:works:harn:kaldor:kaldor_hundreds]] | ''%%{{mdi>fan?size=12}} [[:works:harn:kaldor:kaldor_hundreds]]%%'' | | Fanon works | {{mdi>fan?size=12}} [[:works:harn:kaldor:kaldor_hundreds]] | ''%%{{mdi>fan?size=12}} [[:works:harn:kaldor:kaldor_hundreds]]%%'' |
 | Out-of-print works | {{mdi>grave-stone?size=12}} [[:works:oop:kaldor]] | ''%%{{mdi>grave-stone?size=12}} [[:works:oop:kaldor]]%%'' | | Out-of-print works | {{mdi>grave-stone?size=12}} [[:works:oop:kaldor]] | ''%%{{mdi>grave-stone?size=12}} [[:works:oop:kaldor]]%%'' |
 +
 +Here, out-of-print works are treated as a class of their own. With just the one icon assigned in this role, that is a meaningful distinction to make versus more current works.
  
 In all cases, the size is reduced to 12 pixels from the plugin default value of 16. The coding for this parameter could be possibly shortened like ''%%{{mdi>fan?12}}%%'', but the ''size='' has been retained for the sake of clarity. In all cases, the size is reduced to 12 pixels from the plugin default value of 16. The coding for this parameter could be possibly shortened like ''%%{{mdi>fan?12}}%%'', but the ''size='' has been retained for the sake of clarity.
  
-===== Heading icons =====+==== Heading icons ====
  
-In page headings, there are many more variations of icons. Rather than using the ''Icons plugin'' directly, editors work with the [[:wiki:include_plugin]] to include the content of pages with already-formatted icons. Such an inclusion---within a block atop the [[:wiki:works_template_procedure#adjust_icons|Works new-page template]]---looks like this.+In page headings, there are many more variations of category icons. Rather than using the ''Icons plugin'' directly, editors work with the [[:wiki:include_plugin]] to include the content of pages with already-formatted icons. Such an inclusion---within a block atop the [[:wiki:works_template_procedure#adjust_icons|Works namespace template]]---looks like this.
  
 <code> <code>
Line 28: Line 35:
 </code> </code>
  
-The entire collection of icons is displayed in several ways.+The entire collection of category icons is displayed in several ways.
  
   * [[:icons:start|Icons start]] gives a broad overview.   * [[:icons:start|Icons start]] gives a broad overview.
Line 36: Line 43:
   * [[:works:color_scheme]] lays out the colors used for works icons (and "World" section headings).   * [[:works:color_scheme]] lays out the colors used for works icons (and "World" section headings).
  
-==== Heading icons conventions ====+===== Heading icons conventions =====
  
-  - [[#All_works_get_a_publisher_icon]].+  - [[#All works get a publisher icon]].
     - [[#Columbia Games, Inc. works]]     - [[#Columbia Games, Inc. works]]
     - [[#Keléstia Productions Ltd. works]]     - [[#Keléstia Productions Ltd. works]]
-    - [[#All fanon works]] +    - [[#All fanon works get the same icon]]. 
-  - [[#Out-of-print_works_get_an_icon]].+  - [[#Out-of-print works get an icon]].
     - [[#This is in addition to the publisher icon]].     - [[#This is in addition to the publisher icon]].
 +    - [[#Some Hârnlore magazine issues get the icon]].
     - [[#Superseded Hârnlore magazine articles get the icon]].     - [[#Superseded Hârnlore magazine articles get the icon]].
-  - [[#Magazines_and_articles_get_an_icon]].+  - [[#Magazines and articles get a magazine icon]].
     - [[#There is one color for all magazines]].     - [[#There is one color for all magazines]].
-  - [[#All_works_get_one_or_more_subject_icons]]. +    - [[#Issues have this icon near the start, articles at end]]. 
-    - [[#The main subject comes first]].+  - [[#All works get one or more category icons]]. 
 +    - [[#The main category comes first]].
     - [[#HârnMaster works get a version icon]].     - [[#HârnMaster works get a version icon]].
-    - [[#Subjects of articles within the work get an icon]]. +    - [[#Categories of articles within the work get an icon]]. 
-    - [[#Subjects within mixed articles get an icon if significant]].+    - [[#Categories within mixed articles get an icon if significant]].
     - [[#Realms relevant to the work get an icon each]].     - [[#Realms relevant to the work get an icon each]].
-    - [[#Settlements described in the work get the most suitable icon]]. +    - [[#Settlements described in the work get the most apt icons]]. 
-    - [[#Locations described in the work get the most suitable icon]].+    - [[#Vathrans and thrans follow map symbols]]. 
 +    - [[#Locations described in the work get the most apt icons]].
     - [[#Abbeys get the relevant religion icon]].     - [[#Abbeys get the relevant religion icon]].
     - [[#Settlements with chantries get the relevant magic icon]].     - [[#Settlements with chantries get the relevant magic icon]].
-    - [[#Significant maps in the work get the most suitable icon]].+    - [[#Significant maps in the work get the most apt icon]].
  
 ==== All works get a publisher icon ==== ==== All works get a publisher icon ====
  
-The first icon in the row represents the publisher. The Works namespace template provides ''Include plugin'' code for both Columbia Games, Inc. and fanon.+The first icon in the row represents the publisher. The Works namespace template provides ''Include plugin'' code for both a Columbia Games, Inc. icon and a fanon one.
  
 === Columbia Games, Inc. works === === Columbia Games, Inc. works ===
Line 71: Line 81:
 [[.pages:kpl|The KPL icon]] could be blazoned "Sanguine, a checkbox argent." None of these currently in the wiki has yet gone out of print. [[.pages:kpl|The KPL icon]] could be blazoned "Sanguine, a checkbox argent." None of these currently in the wiki has yet gone out of print.
  
-=== All fanon works ===+=== All fanon works get the same icon ===
  
-[[.pages:ldc|The fanon icon]] could be blazoned "Azure, a fan argent." The icon pagename, ''ldc'', stands for Lýthia Dot Com, but fanon from other sources is represented this way too. At this time, it does not seem helpful to create more distinctions when Lýthia hosts an order of magnitude more works than are found elsewhere.+[[.pages:ldc|The fanon icon]] could be blazoned "Azure, a fan argent." The icon pagename, ''ldc'', stands for Lýthia Dot Com, but fanon from other sources is represented this way too. At this time, it does not seem helpful to create more distinctions since Lýthia hosts an order of magnitude more works than are found elsewhere.
  
 This differs from [[:wiki:tags]], which are created for individual fanon publishers. This differs from [[:wiki:tags]], which are created for individual fanon publishers.
Line 79: Line 89:
 ==== Out-of-print works get an icon ==== ==== Out-of-print works get an icon ====
  
-After the publisher icon, works that are no longer in print and  unavailable in digital form get [[.pages:oop|the out-of-print icon]].+=== This is in addition to the publisher icon === 
 + 
 +After the publisher icon, works that are no longer in print and unavailable in digital form get [[.pages:oop|the out-of-print icon]]. This differs from the way that class icons are treated in listings: those have just one icon while headings can have many category icons.
  
 Yes, CGI may happen to have a few more printed copies of some of these on hand, and one may even be able to purchase them from their website. They are still regarded as out-of-print since they are not printing more nor have they been digitized. Yes, CGI may happen to have a few more printed copies of some of these on hand, and one may even be able to purchase them from their website. They are still regarded as out-of-print since they are not printing more nor have they been digitized.
  
-=== Hârnlore magazine ===+=== Some Hârnlore magazine issues get the icon ===
  
-A notable edge case is that of [[:works:harnlore:]]. Issues #1--9 have been laid out anew, digitized, and pdfs are available for sale. This is not the case for [[:works:harnlore:harnlore_10]], and [[:works:harnlore:harnlore_11]]. While---at the time of this writing---remaining print copies are being sold, that window will close and the rest will be destroyed. They have not, as yet, been digitized.+A notable edge case is that of [[:works:harnlore:]]. Issues #1--9 have been laid out anew, digitized, and pdfs are available for sale. This is not the case for [[:works:harnlore:harnlore_10]], and [[:works:harnlore:harnlore_11]]. While---at the time of this writing---remaining print copies of those latter two are being sold, that window will close and the rest will be destroyed. They have not, as yet, been digitized.
  
-Also, many individual articles from both groups of issues have been reprinted as their own, stand-alone articles. This renders those magazine versions obsolete. An example of this is [[works:harnlore:oselbridge|Oselbridge]] from Hârnlore #7.+Consequently, the pages for the entire magazine for the last two issues get the out-of-print icon. The others do not.
  
-Consequently, the **//pages for the entire magazine//** for the last two issues get the out-of-print icon. The others do not.+=== Superseded Hârnlore magazine articles get the icon ===
  
-**//Pages for the individual articles//** from any magazines get the out-of-print icon only when they have been superseded by subsequently-published articles.+Many individual articles from both groups of issues have been republished into their own, stand-alone articles. This renders the magazine versions obsolete. An example of this is [[works:harnlore:oselbridge|Oselbridge]] from //Hârnlore// #7.
  
-==== Magazines and articles get an icon ====+Pages for the individual articles from any magazines get the out-of-print icon only when they have been superseded by subsequently-published articles.
  
-All magazines and magazine articles get [[.pages:magazines|the magazine icon]]. All magazines are represented by the same icon inclusion. At this time, it has been decided not to differentiate them with color variations.+==== Magazines and articles get a magazine icon ====
  
-While pages for entire magazines have this icon toward the front of the row, pages for articles place it at the end.+All magazines and magazine articles get [[.pages:magazines|the magazine icon]]. All magazines are represented by the same icon inclusion.
  
-==== All works get one or more subject icons ====+=== There is one color for all magazines ===
  
-Next comes at least one icon representing the subject about which the work has been written. These are the same as the sub-namespaces into which the ''works:'' namespace has been divided, such as ''kaldor:'', ''adventures:'', and the like. This system has been modeled on CGi's publications and expanded from there to encompass fanon that stood outside that scheme.+At this time, it has been decided not to differentiate them with color variations.
  
-=== The main subject comes first ===+=== Issues have this icon near the start, articles at end ===
  
-If there is more than one icon that can apply, give precedence to the main subject of the work. For example, an adventure with statistics for a novel monster would get [[.pages:adventures|the adventures icon]] first.+While pages for entire magazines have this icon toward the start of the row on the left, pages for articles place it at the far right.
  
-Sometimes it isn't clear which aspect of a work should take precedence. HârnMaster materials are particularly mingled, one in particular being [[:works:harnmaster:pilots_almanac]]. It has three guild articles with much rules crunch, "World" data tables, a glossary, and regional maps.+==== All works get one or more category icons ==== 
 + 
 +Next comes at least one icon representing the category about which the work has been written. These are the same as the sub-namespaces into which the ''works:'' namespace has been divided, such as ''kaldor:'', ''adventures:'', and the like. This system has been modeled on CGi's publications and expanded from there to encompass fanon that stood outside that scheme. 
 + 
 +=== The main category comes first === 
 + 
 +If there is more than one icon that can apply, give precedence to the main category of the work. For example, an adventure with statistics for a novel monster would get [[.pages:adventures|the adventures icon]] first. 
 + 
 +Sometimes it isn't clear which aspect of a work should take precedence. HârnMaster materials are especially mingled, one in particular being [[:works:harnmaster:pilots_almanac]]. It has three guild articles with much rules crunch, "World" data tables, a glossary, and regional maps.
  
 When in doubt, go with the namespace assignment. Here, ''harnmaster:'' seemed the best place for the small group of maritime works in order to keep them together. Therefore, [[.pages:harnmaster_3|the HârnMaster 3 icon]] comes first. When in doubt, go with the namespace assignment. Here, ''harnmaster:'' seemed the best place for the small group of maritime works in order to keep them together. Therefore, [[.pages:harnmaster_3|the HârnMaster 3 icon]] comes first.
Line 115: Line 135:
 Four general HârnMaster icons have been created: [[.pages:harnmaster_1|HârnMaster 1]], [[.pages:harnmaster_2|HârnMaster 2]], [[.pages:harnmaster_3|HârnMaster 3]], and [[.pages:harnmaster_gold|HârnMaster Gold]]. If the work states that it is for a specific version, use that. If not, go with the latest CGI version at the time it was written or with Gold if that seems more appropriate. Four general HârnMaster icons have been created: [[.pages:harnmaster_1|HârnMaster 1]], [[.pages:harnmaster_2|HârnMaster 2]], [[.pages:harnmaster_3|HârnMaster 3]], and [[.pages:harnmaster_gold|HârnMaster Gold]]. If the work states that it is for a specific version, use that. If not, go with the latest CGI version at the time it was written or with Gold if that seems more appropriate.
  
-=== Subjects of articles within the work get an icon ===+=== Categories of articles within the work get an icon ===
  
-If a work comprises several articles, each treating a different Hârn subject, then each subject so treated should get an icon. These follow the best fit to the order in which they are found.+If a work comprises several articles, each treating a different Hârn category, then each category so treated should get an icon. These follow the best fit to the order in which they are found.
  
 Each work only gets one such icon. A //Friends, Foes and Followers// work with twelve character profiles just gets [[.pages:npcs|one NPCs icon]]. Each work only gets one such icon. A //Friends, Foes and Followers// work with twelve character profiles just gets [[.pages:npcs|one NPCs icon]].
  
-=== Subjects within mixed articles get an icon if significant ===+=== Categories within mixed articles get an icon if significant ===
  
-Even if a work is one article rather than a collection of several, another icon should be displayed if another Hârn subject is treated in a substantial way.+Even if a work is one article rather than a collection of several, another icon should be displayed if another Hârn category is treated in a substantial way.
  
-For instance, ''npcs'' icons are **//not//** given to every settlement article even though many residents are named. However, a full HârnMaster character writeup with game statistics would merit both a ''npcs'' and the game version icons.+For instance, ''npcs'' icons are **//not//** given to every settlement article even though many residents are named. However, a full HârnMaster character writeup with game statistics would merit both the ''npcs'' and the game version icons.
  
 === Realms relevant to the work get an icon each === === Realms relevant to the work get an icon each ===
  
-Obviously, works about Kaldor get the [[.pages:kaldor|Kaldor icon]]. Others may get one too if they are relevant to a Kaldor campaign. This determination can be more generous than that for other, non-realm subjects.+Obviously, works about Kaldor get [[.pages:kaldor|the Kaldor icon]]. Others may get one too if they are relevant to a Kaldor campaign. This determination can be more generous than that for other, non-realm categories.
  
 Examples would be adventures set in Kaldor, wilderness sites near Kaldor, religious orders active in Kaldor, and the like. Examples would be adventures set in Kaldor, wilderness sites near Kaldor, religious orders active in Kaldor, and the like.
Line 137: Line 157:
 Exceptions are articles that touch upon so many realms that the display of icons would grow too large. //Pilot's Almanac// is an example where region icons have been deemed sufficient. The tags there are bad enough. Exceptions are articles that touch upon so many realms that the display of icons would grow too large. //Pilot's Almanac// is an example where region icons have been deemed sufficient. The tags there are bad enough.
  
-=== Settlements described in the work get the most suitable icon ===+=== Settlements described in the work get the most apt icons ===
  
-If an article substantially treats a particular castle, keep, or other settlement, it should get the realm-specific settlement icon that applies.+If an article substantially treats a particular castle, keep, or other settlement, it should get the realm-specific settlement icon that applies. For example, the module on the [[:works:harn:kaldor:tashal]] has [[.pages:realms:city_kaldor| the City in Kaldor icon]].
  
-It had been general practice to give both realm and realm-specific settlement icons when the settlement is a secondary subject, and this still seems best for the purpose of clarity. There are only so many colors, and it may get hard to differentiate them without a region icon added to the realm color for help. +It had been general practice to give both realm and realm-specific settlement icons when the settlement is a secondary category, and this still seems best for the purpose of clarity. There are only so many colors, and it may get hard to differentiate them without a region icon added to the realm color for help.
- +
-The exception has been articles primarily about one settlement, like [[:works:harn:kaldor:tashal]], where the settlement type is clear from the title. However, this may change.+
  
 If no realm-specific icon exists, one can use the generic one, such as [[.pages:keep|the keep icon]]. That with the realm icon will tell the story. If no realm-specific icon exists, one can use the generic one, such as [[.pages:keep|the keep icon]]. That with the realm icon will tell the story.
  
-Alternately, one can format the icon manually, following the syntax on the best-suited icon page. It would not be fully tied into the whole icon complex of pages, but this may not be a big problem. An example might look like this.+Alternately, one can format the icon manually, following the syntax on the best-suited icon page. It would not be fully tied into the whole complex of icon pages, but this may not be a big problem. An example might look like this.
  
 <code> <code>
 +<WRAP icon-pad>
 <WRAP tarkain columbian-icon> <WRAP tarkain columbian-icon>
 {{ra>tower?30&align=left|Keep in Tarkain}} {{ra>tower?30&align=left|Keep in Tarkain}}
-</WRAP>+</WRAP></WRAP>
 </code> </code>
  
-Best of all would be to create the needed icon pages and include them normally. As a practical matter, however, there are already many existing ones that have not been used even once let alone widely.+**Note:** On the actual icon pages, the icon is placed in the label of a link. In an ad-hoc instance such as this, however, there may be no ''icons:pages:realms:keep_tarkain'' to which to link. 
 + 
 +Best of all would be to create the needed icon pages according to the [[new_icon_procedure]] and include them normally. As a practical matter, however, there are already many existing ones that have not been used even once let alone widely. Heck, there aren't even any cities in Chybisa, but [[.pages:realms:city_chybisa|there's an icon for them]]. 
 + 
 +=== Vathrans and thrans follow map symbols === 
 + 
 +There isn't a good equivalence between Ivinian fortified settlements and Hârnic ones. Instead, they are related to castle, keep, and manor icons as they are marked on maps: those having a keep symbol on a map get a keep icon, etc. For example, [[:works:harn:orbaal:zynholm]] gets the [[.pages:realms:keep_orbaal]] while [[:works:harn:orbaal:genheim]] gets the [[.pages:realms:manor_orbaal]]. 
 + 
 +=== Locations described in the work get the most apt icons ===
  
-=== Locations described in the work get the most suitable icon ===+Articles detailing a location smaller than an entire settlement get the appropriate realm-specific location icon. For example, the article on [[:works:harn:kaldor:silver_way_inn]] in Kiban has the [[.:pages:realms:location_kaldor]].
  
-Articles detailing a location smaller than an entire settlement get the appropriate realm-specific location icon. An example Again, if one does not yet exist, [[.pages:location|The generic location icon]] will work.+Again, if one does not yet exist, [[.pages:location|The generic location icon]] will work.
  
 === Abbeys get the relevant religion icon === === Abbeys get the relevant religion icon ===
  
-Icons have been made for all of the major religions. In addition to works where they are a subject, settlements and locations relevant to them get icons. For example [[:works:harn:kaldor:caleme]] has [[.pages:larani|the Larani icon]].+Icons have been made for all of the major religions. In addition to works where they are a category, settlements and locations relevant to them get icons. For example, [[:works:harn:kaldor:caleme]] has [[.pages:larani|the Larani icon]].
  
 === Settlements with chantries get the relevant magic icon === === Settlements with chantries get the relevant magic icon ===
  
-Icons have been made for all the convocations of the Shek-Pvar. In addition to works where they are a subject, settlements and locations relevant to them get icons. For example [[:works:harn:orbaal:gwaeryn]] has [[.page:jmorvi|the Jmorvi icon]].+Icons have been made for all the convocations of the Shek-Pvar. In addition to works where they are a category, settlements and locations relevant to them get icons. For example, [[:works:harn:orbaal:gwaeryn]] has [[.pages:jmorvi|the Jmorvi icon]].
  
 === Significant maps in the work get the most suitable icon === === Significant maps in the work get the most suitable icon ===
Line 175: Line 202:
 Settlement articles have maps almost by definition, so it has not been the practice to place map icons on them. However, significant maps, such as region maps, should get an icon. Settlement articles have maps almost by definition, so it has not been the practice to place map icons on them. However, significant maps, such as region maps, should get an icon.
  
-Series of maps, such as the [[:works:atlas_harnica:]], have their own map icons: [[.page:atlas_harnica|Atlas Hârnica]], [[.page:atlas_ivinia|Atlas Ivinia]], and [[.page:atlas_kelestia|Atlas Keléstia]].+Series of maps, such as the [[:works:atlas_harnica:]], have their own map icons: [[.pages:atlas_harnica]], [[.pages:atlas_ivinia]], and [[.pages:atlas_kelestia]].
  
-In addition to [[.page:maps|the generic map icon]], some region-specific and realm-specific ones have been made as well. Use the most suitable one.+In addition to [[.pages:map|the generic map icon]], some region-specific and realm-specific ones have been made as well. Use the most suitable one.
  
  • icons/conventions.1676936567.txt.gz
  • Last modified: 2023/02/20 15:42
  • by suedunham