wiki:works_template_procedure

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
wiki:works_template_procedure [2023/02/20 13:39] – removed - external edit (Unknown date) 127.0.0.1wiki:works_template_procedure [2024/08/21 13:57] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +====== Works template procedure ======
  
 +When a new page is created in the ''works:'' namespace, a new-page template is loaded into the page editor. The text of it is reproduced [[#full_template_text|below]].
 +
 +**Note:** Hopefully, more will be added to this procedure when the [[refnotes_plugin]] data is added to these pages.
 +
 +Work through the template in these steps.
 +
 +  - [[#Adjust icons]]
 +  - [[#Check title]]
 +  - [[#Adjust tags]]
 +  - [[#Remove text]]
 +  - [[#Adjust thumbnail]]
 +  - [[#Adjust credits]]
 +  - [[#Adjust publisher link]]
 +  - [[#Adjust work links]]
 +  - [[#Adjust copyright]]
 +  - [[#More additions]]
 +
 +===== Adjust icons =====
 +
 +At the top is the icon block.
 +
 +<code>
 +<WRAP icon-line>
 +{{page>icons:cgi&inline}} {{page>icons:ldc&inline}}
 +{{page>icons:some_icon&inline}}
 +</WRAP> FIXME
 +</code>
 +
 +==== Fix publisher icon ====
 +
 +The first line after the opening ''WRAP'' tag contains inclusions of two icon pages; only one of which is needed. ''icons:cgi'' indicates a canon work published by [[:works:publishers:cgi]] and the second a fanon work. Just one icon is used for all fanon regardless of source: ''icons:ldc'' for Lýthia Dot Com. Such duplications repeat down the page.
 +
 +Remove the icon that is not needed. Alternately, edit one to read ''icons:kpl'' for a [[works:publishers:kpl]] work and remove the other.
 +
 +==== Add more icons ====
 +
 +The next icon is simply a placeholder, ''icons:some_icon''. Duplicate that line as needed and edit the page names to point to the right pages.
 +
 +[[:icons:conventions|Works icon conventions]] help to use these features consistently.
 +
 +===== Check title =====
 +
 +The next line is the top-level page heading.
 +
 +<code>
 +====== [generated title] ======
 +</code>
 +
 +The ''@!!PAGE@'' part in the template is DokuWiki [[doku>namespace_templates|template syntax]] that forms a title from the page name. It does not appear in a new page, but the automatically generated title will instead. This is often sufficient but far from automatically successful.
 +
 +Double check that the result is acceptable. Adjust capitalization as needed. Keléstia Publications titles should have any accents added as they appear on the work.
 +
 +[[works_title_conventions|Works title conventions]] help to name these pages consistently.
 +
 +===== Adjust tags =====
 +
 +Immediately under the top-level heading is the line of tags, utilizing the [[tag_plugin]].
 +
 +<code>
 +{{tag>cgi ldc works:some_tag}} FIXME
 +</code>
 +
 +==== Publisher tags ====
 +
 +As the icons above, tags for both ''cgi'' and ''ldc'' are present. Remove one or both as needed. Unlike the icons, not all fanon is grouped together. Currently, the other publisher tags include the following.
 +
 +  * ''kpl'' Keléstia Productions Ltd.
 +  * ''brittannia'' Brittania Game Designs Ltd
 +  * ''chmp'' The CHMP
 +  * ''harniac'' The Harniac
 +  * ''itch'' Itch.io
 +  * ''lantern'' Lantern Productions
 +  * ''tmc'' The Melderyn Campaign
 +  * ''sophia'' Sophia's Chybisa Page
 +  * ''warflail'' WarFlail's Armory
 +  * ''tyh'' The Yellow Hand
 +
 +==== Other tags ====
 +
 +With the exception of the publishers, all other tags belong to the ''works:'' tag namespace. Tag namespaces differ from page namespaces, and the tag ones don't have sub-namespaces.
 +
 +what is present is simply a placeholder: ''works:some_tag''. It is also useful as a filter in listings derived from tags to exclude new page templates.
 +
 +Replace it as needed and continue adding tags. [[works_tag_conventions|Works tag conventions]] help to use these features consistently.
 +
 +===== Remove text =====
 +
 +Next is a bit of boilerplate text for use if a given work's creator(s) is not known. If that is the case, keep it. Otherwise, delete.
 +
 +<code>
 +The present editor does not own this work and cannot verify the credits. Please add this information if you have it. FIXME\\
 +Add, edit, or remove rows below as required.DELETEME\\
 +</code>
 +
 +===== Adjust thumbnail =====
 +
 +Next is the opening tag of the ''workblock'' class used by the [[wrap_plugin]]. After that is the ''thumbcolumn'' class, with two possibilities for a thumbnail image.
 +
 +<code>
 +<WRAP workblock>
 +<WRAP thumbcolumn>
 +{{ @PAGE@_cover.jpg?nolink }}{{ works:lythia_logo.png?nolink }}
 +</WRAP>
 +</code>
 +
 +A canon article uses a thumbnail derived from the work's cover while fanon usually uses a generic logo. Remove at least one of these.
 +
 +==== Canon images ====
 +
 +Thumbnail images need to be uploaded to the wiki with the Media Manager. [[works_thumbnail_conventions|Works thumbnail conventions]] help to use these features consistently.
 +
 +Like the top-level page heading, the canon image name is derived from the page name when it is created. Check that it matches the image filename and that the extension is correct. Preview the page and see that something appears.
 +
 +==== Fanon images ====
 +
 +For most fanon, the Lýthia image is ready as is. There are images for most of the other fanon publishers already present in the wiki media.
 +
 +  * brittannia_logo.png
 +  * harniac_logo.gif
 +  * lantern_logo.jpg
 +  * sophia_logo.png
 +  * tmc_logo.gif
 +
 +For the rest, the CHMP doesn't give us anything to work with, and the few of both ''itch'' and ''warflail'' works have good covers to use instead.
 +
 +==== Alternate layouts ====
 +
 +The ''thumbcolumn'' Wrap class suffices for most works, but some require a different layout. Other classes have been created for more specialized needs. So far, this means that two covers are displayed side by side, [[:works:atlas_kelestia:atlas_kele_shkn-a9ax|for instance here]].
 +
 +<code>
 +<WRAP workblock>
 +<WRAP thumbcolumn-double>
 +<WRAP half-width-centered>
 +{{shkn-a9_cover.jpg?nolink}}
 +</WRAP>
 +<WRAP half-width-centered>
 +{{shkn-ax_cover.jpg?nolink}}
 +</WRAP>
 +</WRAP>
 +</code>
 +
 +===== Adjust credits =====
 +
 +After the thumbnail, the rest of the ''workblock'' class holds the credits table.
 +
 +<code>
 +<WRAP creditscolumn>
 +^  Credits  ||
 +^        Writers | [[credits:some_person|Some Person]] |
 +^  Map and Plans |  |
 +^           Maps |  |
 +^  Illustrations |  |
 +^         Artist |  |
 +^       Heraldry |  |
 +^        Editors |  |
 +^         Layout |  |
 +^   Contributors |  |
 +</WRAP></WRAP>
 +</code>
 +
 +This is a generic table of common credits lines. Add, edit, or remove lines as needed to reproduce what is written in the work. Alternately, copy the actual table from the work and paste it in.
 +
 +==== Edit credits ====
 +
 +In the second line, add links to the names formatted as the "Some Person" entry. By wiki convention, initials are followed by a period, and there is no space between consecutive initials, such as ''credits:j.m._roegner''.
 +
 +This gets to be a pain for long tables with many names. The present editor has taken to doing this in a text editor with a chain of [[https://www.rexegg.com/|regular expression]] find/replace operations. There is also a Python routine kicking around somewhere as part of a larger data scraping effort, but it may not be ready for sharing.
 +
 +==== Check names ====
 +
 +There can be spelling errors or variations in the names, both made by editors or from the source. Double check that isn't already a name in the [[:credits:]] resembling any that show up red on preview. If the editor has made an error or if it can be fixed with slight styling changes like adding a period after an initial, make that change on the new ''works:'' page. If it is a new variation on an existing name straight from the source, add a new [[credits_template_procedure|credits page]].
 +
 +Most of the people already have their pages set up, but there can always be new ones. If so, create a new ''credits:'' page for the new name.
 +
 +==== Additional information ====
 +
 +Sometimes the credits block in the work contains additional information about its origin, such as the following (with the title from the source replaced with a link to its works page).
 +
 +<code>
 +Portions of this article were originally published in 1987 in [[..:..:oop:castles_of_harn]].
 +</code>
 +
 +In this case, paste it below the copyright as described in [[#more_additions]].
 +
 +==== Credits examples ====
 +
 +Some works have more elaborate credits setups that may be mimicked in appropriate circumstances, such as the following.
 +
 +  * [[:works:thonahexus:thona_12]]
 +  * [[:works:harn:orbaal:arathel]]
 +  * [[:works:bestiary:harnworld_bestiary]]
 +
 +===== Adjust publisher link =====
 +
 +Next is the line with the link to the work's publisher and a dummy catalog number.
 +
 +<code>
 +{{mdi>checkbox-marked}} [[works:publishers:cgi]] {{mdi>fan}} [[works:publishers:ldc]] #5001 FIXME
 +</code>
 +
 +Again, duplicated values are present. There is a canon icon (using the [[icons_plugin]], ''%%{{mdi>checkbox-marked}}%%'', followed by the link to the wiki page for ''cgi''. After that is the fanon icon and a link to ''ldc''. Remove one and edit the other, if needed.
 +
 +The page names for the ''works:publishers:'' namespace follow the pattern of those equivalent tags and thumbnails, //i.e.// ''kpl'', ''brittannia'', etc.
 +
 +After that is ''#5001'', which is the Columbia number for [[works:core:harnworld]]. Edit or delete as needed. If, instead of a catalog number, there is something else like an ISBN, paste that in.
 +
 +===== Adjust work links =====
 +
 +Next are the buttons for linking the pages from which the work can be obtained. **Note:** non-breaking spaces are used here before the first button and at the beginnings of the button link labels to ensure the desired spacing.
 +
 +<code>
 +  <button icon="fa fa-book">[[http://columbiagames.com/cgi-bin/query/harn/cfg/single.cfg?product_id=5001|  get print]]</button>
 +<button icon="fa fa-file-pdf-o">[[http://columbiagames.com/cgi-bin/query/harn/cfg/single.cfg?product_id=5001-PDF|  get pdf]]</button>FIXME
 +</code>
 +
 +The first button is for a printed version of the work, and the second is for a pdf. If there is only one option for the given work, remove the excess button.
 +
 +==== Edit button links ====
 +
 +The button links text provided by the template points to //HârnWorld// at the Columbia site. Replacing the ''5001'' values with another catalog number will redirect the link to that work instead.
 +
 +Otherwise, replace the link address with that of the correct page.
 +
 +==== Edit button icons and labels ====
 +
 +It may be that there are more accurate icons and labels that may apply to the work's format. The icons are from [[https://fontawesome.com/v4/icons/|Font Awesome]], and the names of icons for other file types can be found there. Already in use in HârnWiki are the following.
 +
 +  * ''fa-file-excel-o''
 +  * ''fa-file-word-o''
 +  * ''fa-file-o''
 +  * ''fa-file-zip-o''
 +  * ''fa-file-image-o''
 +  * ''fa-map-o''
 +
 +Change the link label to reflect the icon or more accurately portray the nature of the download. One exception: though technically Lýthia downloads are all ''zip'' files, the ones that are just a ''zip'' of one ''pdf'' use the given button as is.
 +
 +==== Check links ====
 +
 +Preview the page and click the links to verify that they point correctly.
 +
 +===== Adjust copyright =====
 +
 +Next is a stand-in for the work's copyright.
 +
 +<code>
 +(c) Copyright 1983-2014, N. Robin Crossby & Columbia Games, Inc.FIXME
 +</code>
 +
 +Paste the relevant line from the work in its place.
 +
 +===== More additions =====
 +
 +The last part of the template is destined for the bottom of the page. It is a section using the [[backlinks_plugin]] to track where in the ''harn:'' namespace the work has been cited.
 +
 +It occurrs to the present editor only now that this won't work for citations from ''ivinia:'', ''shorkyne:'', ''trierzon:'', or ''kethira:'' as is. This will have to be worked out at some point in the future.
 +
 +<code>
 +===== Pages citing this work =====
 +{{backlinks>.#harn}}
 +</code>
 +
 +In many cases, the job is well begun at this stage and the page can be saved, but some works should have more said about them. Between the copyright and the backlinks section, any more information may be added.
 +
 +==== Other additions examples ====
 +
 +Here are some pages that have had additions made. Some of these may be worth emulating, some may suit these individual pages and no others, and some may eventually need standardizing. This is by no means an exhaustive list of the possibilities: add whatever seems fitting.
 +
 +  * [[:works:adventures:inns]]---Location summary
 +  * [[:works:harn:rethem:shostim]]---Content available in another work
 +  * [[:works:kethira:quarphor_map]]---Login required
 +  * [[:works:bestiary:cats]]---Beasts list
 +  * [[:works:bestiary:fatherless_multitude]]---Beasts table
 +  * [[:works:bestiary:beastiary_v3]]---Long beasts table
 +  * [[:works:bestiary:aquatics_expansion]]---More beasts
 +  * [[:works:adventures:bognors_folly]]---Several categories of contents
 +  * [[:works:oop:encyclopedia_harnica:encyclopedia_harnica_16]]---Composite work contents
 +  * [[:works:harnmaster:pilots_almanac]]---Composite work contents
 +  * [[:works:npcs:fff:friends_foes_20_21]]---NPC roster
 +
 +===== Other works templates =====
 +
 +In additional to this general template for most sub-namespaces, some areas have more individual treatments.
 +
 +==== Atlas templates ====
 +
 +The various Atlas namespaces have templates largely like this one but with a few quirks. The present editor may write about them if there is ever another map produced again.
 +
 +==== Out-of-print templates ====
 +
 +Likewise, templates for out-of-print works have their own wrinkles. Though a few yet remain to have pages created, these too are a low priority for documentation at the moment.
 +
 +===== Full template text =====
 +
 +<code>
 +<WRAP icon-line>
 +{{page>icons:cgi&inline}} {{page>icons:ldc&inline}}
 +{{page>icons:some_icon&inline}}
 +</WRAP> FIXME
 +
 +====== @!!PAGE@ ======
 +{{tag>cgi ldc works:some_tag}} FIXME
 +
 +The present editor does not own this work and cannot verify the credits. Please add this information if you have it. FIXME\\
 +Add, edit, or remove rows below as required.DELETEME\\
 +<WRAP workblock>
 +<WRAP thumbcolumn>
 +{{ @PAGE@_cover.jpg?nolink }}{{ works:lythia_logo.png?nolink }}
 +</WRAP>
 +<WRAP creditscolumn>
 +^  Credits  ||
 +^        Writers | [[credits:some_person|Some Person]] |
 +^  Map and Plans |  |
 +^           Maps |  |
 +^  Illustrations |  |
 +^         Artist |  |
 +^       Heraldry |  |
 +^        Editors |  |
 +^         Layout |  |
 +^   Contributors |  |
 +</WRAP></WRAP>
 +
 +{{mdi>checkbox-marked}} [[works:publishers:cgi]] {{mdi>fan}} [[works:publishers:ldc]] #5001 FIXME
 +
 +<button icon="fa fa-book">[[http://columbiagames.com/cgi-bin/query/harn/cfg/single.cfg?product_id=5001|  get print]]</button>
 +<button icon="fa fa-file-pdf-o">[[http://columbiagames.com/cgi-bin/query/harn/cfg/single.cfg?product_id=5001-PDF|  get pdf]]</button>FIXME
 +
 +(c) Copyright 1983-2014, N. Robin Crossby & Columbia Games, Inc.FIXME
 +
 +===== Pages citing this work =====
 +{{backlinks>.#harn}}
 +
 +</code>