Difference between revisions of "Standards"

From Fancyclopedia 3
Jump to navigation Jump to search
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{fixme}}
 
 
 
== Style==
 
== Style==
  
 
* Don't write entries describing events as current or future ("is currently", "in a forthcoming"), as they will become confusing with time. The exception is conventions that can say "will be held".
 
* Don't write entries describing events as current or future ("is currently", "in a forthcoming"), as they will become confusing with time. The exception is conventions that can say "will be held".
 +
 +
==Templates==
 +
 +
We use mediawiki  [[Templates]] to collect structured data. For example [[Template:Person]] or [[Template:Convention]] which should be included with <nowiki>{{person | born=????}} or {{convention}}</nowiki>. The template pages give documentation on the arguments, all of which are optional, though you might get nag messages if obvious things, like the year of a convention, are missed.
  
 
== People==
 
== People==
We have a more-or-less standard template for people entries.  (Notes are in <pointy brackets>):
+
We have a more-or-less standard approach for people entries.  (Notes are in <pointy brackets>):
  
 
{| border="1" cellspacing="0" cellpadding="5" align="center"
 
{| border="1" cellspacing="0" cellpadding="5" align="center"
 
| <pre>
 
| <pre>
(1932 -- July 31, [[1999]])
+
(1932 -- July 31, 1999)
  
Blah, blah, blah. Lorem ipsum...
+
Blah, blah, blah. Lorem ipsum...<ref>says me</ref>
 
<The biography goes here. It may be short or it may occupy hundreds of lines.>
 
<The biography goes here. It may be short or it may occupy hundreds of lines.>
  
Line 27: Line 29:
 
<Award winners only. Only mention nominations for Hugo Awards, where nomination itself is notable>
 
<Award winners only. Only mention nominations for Hugo Awards, where nomination itself is notable>
  
{{person}}
+
<references />
 +
{{person | born=1932 | died=1999}}
 
[[Category:fan]]
 
[[Category:fan]]
 
[[Category:US]] <or whatever>
 
[[Category:US]] <or whatever>
Line 34: Line 37:
 
|}
 
|}
  
 +
==Publications==
 +
 +
<pre>
 +
Description<ref>really</ref>
 +
 +
{{prizes}}
 +
* 1990 -- '''[[1990 Best Novel Hugo|Best Novel Hugo]]'''
  
 +
<references />
 +
{{publication | year = 1978}} or {{publication | start=1978 | end=1992}}
 +
[[Category:Fanzine]] <or whatever>
 +
[[Category:US]] <or whatever>
 +
</pre>
 
   
 
   
 
== Page titles==
 
== Page titles==
Line 42: Line 57:
 
If uncertain about a phrase, type it in {{link | website=https://www.titlecase.com | text=www.titlecase.com}}  which reports for AP-style:
 
If uncertain about a phrase, type it in {{link | website=https://www.titlecase.com | text=www.titlecase.com}}  which reports for AP-style:
  
a an and at but by for in of on or the to up
+
Use lower case: a an and at but by for in of on or the to up
  
Above  About  Across  Against  Along  Among  Around  As  Before  Behind  Below  Beneath  Beside  Between  Beyond  Down  During  Except  From  Inside  I Into Is It Like Near  Off Since Toward Through  Under Until Upon With Within
+
Capitalize: Above  About  Across  Against  Along  Among  Around  As  Before  Behind  Below  Beneath  Beside  Between  Beyond  Down  During  Except  From  Inside  I Into Is It Like Near  Off Since Toward Through  Under Until Upon With Within
  
Or we could use the New York Manual of style as implemented in python module {{link | website=https://github.com/ppannuto/python-titlecase | text=titlecase}} which has a command-line titlecase which produces
+
We will create redirects in Mediawiki as necessary to redirect different usage to the standard, titlecase forms, e.g. "SF writer" will redirect to "SF Writer".
 
 
a an and as at but by for in of on or the to
 
 
 
Above About Across Against Along Among Around Before Behind Below Beneath Beside Between Beyond Down During Except From Inside I Into Is It Like Near Off Since Toward Through Under Until Up Upon With Within
 
 
 
We will create redirects in Mediawiki to redirect different usage to the titlecase forms, eg SF writer to SF Writer.
 
  
 
Acronyms/Initialisms should be in ALL CAPS
 
Acronyms/Initialisms should be in ALL CAPS
Line 79: Line 88:
 
==Clashing Names==
 
==Clashing Names==
  
If a name is used for two things, don't put them on the same page. The better known item can have the main page, others should have have a (caveat) in the title, as in
+
How do we handle more than one page with the same name? This is pretty complicated, alas, and we have a [[Clashing Names|page devoted to just this topic]].
 
 
Windycon
 
<pre>
 
(Did you mean the [[Windycon (NZ)|New Zealand Natcon]]?)
 
 
 
Description...
 
</pre>
 
 
 
Windycon (NZ)
 
<pre>
 
{{DISPLAYTITLE:Windycon}}
 
(Did you mean the annual Chicago convention [[Windycon]]?)
 
 
 
Description...
 
</pre>
 
 
 
The DISPLAYTITLE is what appears at the top of the page and in links, so you just refer to <nowiki>[[Windycon (NZ)]]</nowiki> and it will show Windycon on the page.
 
 
 
If there are lots of clashes, like with [[Unicon]], create a special disambiguation page
 
<pre>
 
(Did you mean [[Unicon (UK)|British]], [[Unicon (Australia)|Australian]], [[Unicon (MD)|Maryland]], [[Unicon (CA)|Californian]], [[Unicon (KC)|Kansas City]] or [[Unicon (FL)|Florida]] conventions of that name?)
 
 
 
Or do you know of yet another one!
 
{{choice}}
 
</pre>
 
 
 
It will show all the incoming links to that page, which we aim to correct to the direct route.
 
 
 
The (caveat) should be things like (NZ) (Weston fanzine) (clubzine)
 
 
   
 
   
 
== References to Publications==
 
== References to Publications==
Fancy has the hope of -- eventually -- automatically linking from references to publications in its articles to the publication itself on its companion site, fanac.org. To prepare for that day, we have a simple standard for a '''very few''' fanzines and convention publication references. Currently only '''[[File 770]], [[Ansible]] and [[The National Fantasy Fan]] (TNFF)'''
+
Fancy has the hope of -- eventually -- automatically linking from references to publications in its articles to the publication itself on its companion site, fanac.org. To prepare for that day, we have a simple standard for a '''very few''' fanzines and convention publication references. Currently only '''[[File 770]], [[Ansible]], [[Ratatosk]], and [[The National Fantasy Fan]] (TNFF)'''
  
 
To refer to a fanzine as a whole (that is, not to a specific issue) use
 
To refer to a fanzine as a whole (that is, not to a specific issue) use
Line 123: Line 103:
 
  <nowiki>{{File770 | issue=23 | page=4}}</nowiki>
 
  <nowiki>{{File770 | issue=23 | page=4}}</nowiki>
 
  <nowiki>{{Ansible | issue=23 | item=4}}</nowiki>
 
  <nowiki>{{Ansible | issue=23 | item=4}}</nowiki>
 +
<nowiki>{{Ratatosk | issue=35 | page=2}}</nowiki>
 
  <nowiki>{{TNFF | volume=5 | number=6 | page=12 | text=description}}</nowiki>
 
  <nowiki>{{TNFF | volume=5 | number=6 | page=12 | text=description}}</nowiki>
  
Line 130: Line 111:
  
 
Don't create pages for "X, someone who does Y", just create a redirect X that points to Y. If something has no independent existence, like awards only given at a particular convention, or someone's pet, add detail to the parent page. The site is about fandom, don't create pages about they things fans do in the rest of their lives
 
Don't create pages for "X, someone who does Y", just create a redirect X that points to Y. If something has no independent existence, like awards only given at a particular convention, or someone's pet, add detail to the parent page. The site is about fandom, don't create pages about they things fans do in the rest of their lives
 +
 +
So, for example, "Con runner" redirects to "Con Fandom".  Note that we make a point of using the term "Con runner" in the Con Fandom page and we make it bold. This helps the reader who expected a definition of "con runner" to understand find it.
  
 
== Year links==
 
== Year links==
Line 135: Line 118:
 
Use links to year pages very sparingly. Any years in the bottom templates will become links automatically, don't duplicate the links in the article body.
 
Use links to year pages very sparingly. Any years in the bottom templates will become links automatically, don't duplicate the links in the article body.
  
For fanzines and publishers the year it was first published/founded (and restarted if significant)
+
Year links should be avoided in tables or lists.
  
For a person, their year of death.
+
You may come across year of death as a link in the top line, this is being phased out in favour of died=XXXX in the person template. If you don't know the year, either omit or use ????
 
 
Year links should be avoided in tables or lists.
 
  
Don't have year links before 1900.
+
The exception for using year of publication is for fan-fund trip reports and fanhistory articles, when the dates the events occurred should be used.
  
 
== Sequences==
 
== Sequences==
Line 147: Line 128:
 
To provide links forward and backwards in a sequence of conventions, awards etc, use:
 
To provide links forward and backwards in a sequence of conventions, awards etc, use:
  
  <nowiki>{{convention | before=Picocon 32 | after=Picocon 34}}</nowiki>
+
  <nowiki>{{convention | series=Picocon | before=Picocon 32 | after=Picocon 34 | series1=Eurocon | before1=Eurocon 10 | after1=Eurocon 12}}</nowiki>
  
 
== Future proofing external site links==
 
== Future proofing external site links==
Line 159: Line 140:
 
{{link | website=http://www.nesfa.org/boskone|text=Excellent Website|capture=2018}}
 
{{link | website=http://www.nesfa.org/boskone|text=Excellent Website|capture=2018}}
  
The link will be shown in hover text with the Internet Archive as an optional extra (IA)
+
A link going dead is not a reason to remove it. Please avoid using url shortening services, as that introduces another point of failure, and negates the use of using the Internet Archive.
  
A link going dead is not a reason to remove it.
+
The key website for an entry should go in the template line as a '| website=http...' rather than using a separate link template. This builds up a better controlled database.
  
 
[[Category:redirect]]
 
[[Category:redirect]]

Revision as of 13:45, 21 May 2020

Style[edit]

  • Don't write entries describing events as current or future ("is currently", "in a forthcoming"), as they will become confusing with time. The exception is conventions that can say "will be held".

Templates[edit]

We use mediawiki Templates to collect structured data. For example Template:Person or Template:Convention which should be included with {{person | born=????}} or {{convention}}. The template pages give documentation on the arguments, all of which are optional, though you might get nag messages if obvious things, like the year of a convention, are missed.

People[edit]

We have a more-or-less standard approach for people entries. (Notes are in <pointy brackets>):

(1932 -- July 31, 1999)

Blah, blah, blah. Lorem ipsum...<ref>says me</ref>
<The biography goes here. It may be short or it may occupy hundreds of lines.>

{{fanzines}} <skip this section altogether if empty>
* [[Fanzine 1]] [1973-77]
* [[Apazine 2]] [1988-95] (for [[FAPA]])
* [[Fanzine 3]] [1994] (with [[Another Fan]])

{{recognition}}  <skip this section altogether if empty>
* 1989 -- [[Fantasticon 3]] <a GoHship>
* 1990 -- '''[[1990 Best Novel Hugo|Best Novel Hugo]]''' for ''Waterworld''  
* 1991 -- [[1991 Best Novel Hugo|Best Novel Hugo]] nominee for ''Fireworld''  
* 1992 -- [[Filk Hall of Fame]]  
<Award winners only. Only mention nominations for Hugo Awards, where nomination itself is notable>

<references />
{{person | born=1932 | died=1999}}
[[Category:fan]]
[[Category:US]] <or whatever>
[[Category:Filk]] <as appropriate>

Publications[edit]

Description<ref>really</ref>

{{prizes}}
* 1990 -- '''[[1990 Best Novel Hugo|Best Novel Hugo]]'''

<references />
{{publication | year = 1978}} or {{publication | start=1978 | end=1992}}
[[Category:Fanzine]] <or whatever>
[[Category:US]] <or whatever>

Page titles[edit]

Mediawiki titles are case sensitive (unlike Wikidot), so we need to be consistent in page names. They should be in title case, which keeps conjunctions and prepositions in lower case. Read up on it here

If uncertain about a phrase, type it in www.titlecase.com which reports for AP-style:

Use lower case: a an and at but by for in of on or the to up

Capitalize: Above About Across Against Along Among Around As Before Behind Below Beneath Beside Between Beyond Down During Except From Inside I Into Is It Like Near Off Since Toward Through Under Until Upon With Within

We will create redirects in Mediawiki as necessary to redirect different usage to the standard, titlecase forms, e.g. "SF writer" will redirect to "SF Writer".

Acronyms/Initialisms should be in ALL CAPS

The Naming of Names[edit]

Names are important, since we want all references to a person or place or thing to go to that P/P/T's page. For that reason we have a simple set of rules for links:

  • Pages should be created under the most commonly used form of a name, and where two versions are comparably commonly used, we will use the less ambiguous version. Examples:

# "Walt Willis", not "Willis" or "Walter A. Willis" (it is less ambiguous, but also much less commonly used) or "WAW" # "E. E. Smith", not "Doc Smith" or "Edward Elmer Smith, PhD" # "LASFS", not "Los Angeles Science Fantasy Society" (Everyone calls it "LASFS".)

  • When using initials, use periods and put spaces between them. So "E. E. Smith", not "EE Smith".
  • When you are dealing with an ambiguous reference, create a link using an unambiguous form. So if the reference was "When Walt got back to Belfast" you would link it as "When Walt got back to Belfast".
  • When multiple forms of a name exist, add redirects from the lesser-used forms to the main page.
  • Use redirects only where the form being redirected is reasonably unique. So, we would not redirect "Walt" to "Walt Willis" because there are other well-known Walts in Fancy. But we would redirect "Willis" in spite of their being other Willises -- none of the rest would likely be referred to by last name alone.

A redirect makes a page just a pointer to another page. If we've written up a page named "E. E. Smith", we also want references to "Doc Smith" to point there. We do this by creating a "Doc Smith" page and redirecting it to the "E. E. Smith" page.

A redirect is done by putting the line

#REDIRECT [[E. E. Smith]]

on the page.

(Feel free to ignore this -- the editors will be scurrying around behind the scenes adding redirects as necessary.)

Clashing Names[edit]

How do we handle more than one page with the same name? This is pretty complicated, alas, and we have a page devoted to just this topic.

References to Publications[edit]

Fancy has the hope of -- eventually -- automatically linking from references to publications in its articles to the publication itself on its companion site, fanac.org. To prepare for that day, we have a simple standard for a very few fanzines and convention publication references. Currently only File 770, Ansible, Ratatosk, and The National Fantasy Fan (TNFF)

To refer to a fanzine as a whole (that is, not to a specific issue) use

[[File 770]]

To refer to a specific issue use

{{File770 | issue=23}}


To refer to a specific page, use

{{File770 | issue=23 | page=4}}
{{Ansible | issue=23 | item=4}}
{{Ratatosk | issue=35 | page=2}}
{{TNFF | volume=5 | number=6 | page=12 | text=description}}

The template adds leading 0s as required.

Is there already a page for that?[edit]

Don't create pages for "X, someone who does Y", just create a redirect X that points to Y. If something has no independent existence, like awards only given at a particular convention, or someone's pet, add detail to the parent page. The site is about fandom, don't create pages about they things fans do in the rest of their lives

So, for example, "Con runner" redirects to "Con Fandom". Note that we make a point of using the term "Con runner" in the Con Fandom page and we make it bold. This helps the reader who expected a definition of "con runner" to understand find it.

Year links[edit]

Use links to year pages very sparingly. Any years in the bottom templates will become links automatically, don't duplicate the links in the article body.

Year links should be avoided in tables or lists.

You may come across year of death as a link in the top line, this is being phased out in favour of died=XXXX in the person template. If you don't know the year, either omit or use ????

The exception for using year of publication is for fan-fund trip reports and fanhistory articles, when the dates the events occurred should be used.

Sequences[edit]

To provide links forward and backwards in a sequence of conventions, awards etc, use:

{{convention | series=Picocon | before=Picocon 32 | after=Picocon 34 | series1=Eurocon | before1=Eurocon 10 | after1=Eurocon 12}}

Future proofing external site links[edit]

External website links are fickle, so we want a way to use the Internet Archive as a backup. Use:

{{link | website=http://www.nesfa.org/boskone}}

or

{{link | website=http://www.nesfa.org/boskone|text=Excellent Website|capture=2018}}
  

to give Website and Excellent Website

A link going dead is not a reason to remove it. Please avoid using url shortening services, as that introduces another point of failure, and negates the use of using the Internet Archive.

The key website for an entry should go in the template line as a '| website=http...' rather than using a separate link template. This builds up a better controlled database.