View source for User:Ohconfucius/script/Sources

{{User:Ohconfucius/banner}}
{{Message
 | bgcolor      = lightblue
 | border-color = royalblue
 | color        = 
 | linkcolor    = 
 | message      = bug report or suggestion
 | link         = User talk:Ohconfucius/script
 | extra-style  = extra styles, like border-radius etc...
 | width        = 
 | margin       = 20px
 | padding      = 20px
 | text-align   = left
}}
== Objectives ==
Main objectives, as applied to reference sections or otherwise within citation templates, are as follows:
#make source name congruent with WP article namespace of same
#italicisation is applied in accordance with [[WP:ITALICS]]
#Wiki-link neutral, usually links will not be removed although links may be piped in certain cases where necessary
#Space neutral &ndash; there should be no impact on the disposition of spaces before or after parameters in edit mode
#clean up superfluous data, parameter miscategorisations, etc. from data trawling by [[WP:Reflinks|Reflinks]] 
#retraining of redirecting (indirect) piped links, where these impact the working of the script 
#remove unpopulated parameters within citation templates
#remove hyperlinks within {{para| journal}}, {{para| website}}, {{para|work}} and {{para|publisher}} fields ([[:Category:CS1 errors: external links|CS1 errors]])
#where the contents of {{para|work}} and {{para|publisher}} is identical, the two are merged (i.e. one of them is discarded). 
#unification: ensure uniqueness of each of {{para|work}} {{para|publisher}} and {{para|location}}; please check that the desired one is retained.

== General principles ==
The rationale and principles applied are as follows:
*urls situated within {{para|url}} are protected; this protection extends to any linking text (e.g.: <nowiki>whether "http://time.com", or "[http://money.cnn.com/2008/02/18/news/newsmakers/siklos_calhoun.fortune/index.htm Siklos, Richard. “Made to Measure” ''Fortune Magazine'', February 20, 2008]"</nowiki>); 
* sources cited are to be retrained where a journal is traditional media (e.g. ''The Times'') and its online version (e.g. Times Online or times.co.uk) is cited
* the terms 'online', 'magazine' or 'newspaper' is dropped unless its use conforms with the Wiki naming conventions of the traditional source. (e.g. ''Time'' and not ''Time Magazine''; ''The Guardian'' and not ''Guardian Unlimited'')
* the traditional journal name (e.g. ''The New York Times'') should reflect the article namespace, with attention being paid to the [[Article (grammar)|article]] in the subject name (e.g. ''<u>The</u> New York Times''); similarly, consistent stylisation should also be ensured (e.g. ''The Globe <u>and</u> Mail'' - without the ampersand); 'AFP' will be expanded to 'Agence France-Presse'
* italicisation will be done on an 'opt-in' basis, although an 'intuitive basis' will also be applied
:# sites with names sounding like traditional media or that contain words like 'Daily', 'Weekly', 'Monthly', 'Magazine', 'Times', 'Observer' are italicised. 
:#new media sources will be non-italicised by default; names suffixed <code>.com</code>, <code>.org</code>, <code>.net</code>, etc are classed as 'publisher' and unitalicised
:#In line with convention, television channels (e.g. BBC1, Fox News) and networks (particularly US TV and radio stations that use 4-lettered call signs beginning with a "K" or "W") remain unitalicised, whilst only programmes (e.g. ''[[Newsnight]]'' or ''[[Today (BBC Radio 4)|Today]]'') are considered 'works'
:#Portals (e.g., Yahoo!, Google, ESPN, etc), as well as their individual channels (e.g., Yahoo! Music, Google News, ESPNcricinfo, etc), are unitalicised
:#news agencies (e.g., Reuters, AFP etc) will be classed as 'agencies' within citation templates even though they may also be acting as publishers in certain cases. They remain <u>un</u>italicised.
:#{{para|via}} is used for [[WP:SPS|Self-published sources]] such as Youtube or Vimeo
:* functionally, correct italicisation will be performed by switching to an appropriate parameter (to or from {{para|work}}, {{para|newspaper}} or {{para|journal}} <&ndash;> {{para|publisher}}); '{{para|work}}' is used to achieve italicisation when switching from {{para|publisher}} as the script cannot customise to the citation template being used).
*Citations to [[WP:PRIMARY|primary sources]] (social media sites such as Twitter, Facebook) are tagged {{tl|Primary source inline}}
* as {{para|title}} renders the title with double quote marks, extra double quote marks bounding the title will be removed. 
*{{para|journal}}, {{para|work}}, {{para|newspaper}}, {{para|periodical}}, where correctly used to denote journals or other works that ought to render as italicised (per [[WP:ITALIC]]) will not be disturbed. 
* publication locations 
:#are not given for e-sources; but they are generally not removed either
:#are unlinked
:#may be used to disambiguate names that are used for publications of different places (e.g. ''The Sun'' may refer to unrelated publications in Hong Kong, Malaysia, Nigeria and the United Kingdom)
* In general, linking status will be respected by the main function unless such preservation involves complex piping that cannot be easily scripted for; a separate button is provided for unlinking ''all'' sources. 
* Where sources are news reports, publisher name is unnecessary – per documentation at {{tl|citation}} – the cited publications themselves are often better-known than their publishers. Thus some publishers fields and publisher names are removed outright to reduce template clutter (e.g. "{{para|publisher|The New York Times Company}}" is removed for {{para|work|The New York Times}}, "{{para|publisher|Time Inc.}}" is removed for {{para|work|Time}}). 
* as indicated on the doc to the {{tl|citation}} templates, publication locations are given only where the source is not well-known (i.e. not BBC or CNN) or this isn't obvious from the journal name (''San Francisco Chronicle'' vs ''The Telegraph'');
* Citations to internal articles (even in other non-English language WPs) and certain deprecated sources may be removed. Care should therefore be exercised when the script is used on articles for [[The Epoch Times]] and [[Daily Mail]], as use is permitted under [[WP:SELF]].
* some unpopulated fields within citation templates may be removed
<!-- * removal where language parameter is English – English being the default language in en.wp  (disabled June 2020 rem of non-displaying template parameter-->
* Correction of [[Help:CS1 errors|CS1 errors]]: 
:#Removal of external link in any of the [[Help:Citation Style 1|CS1]] or [[Help:Citation Style 2|CS2 citation]] title-holding parameters;
:#*Where the "{{para|title}}" mistakenly contains an URL, it will be blanked with a commented <nowiki><!--ACTUAL ARTICLE TITLE BELONGS HERE! original text: [url]--></nowiki>; 
:#*Where parameters other than {{para|url}} (e.g. chapter, journal, magazine, newspaper, publisher, title, work, via) contain hyperlinked text, the URL part is removed, leaving only the text; the strings <code>http://</code> and <code>www.</code> are systematically removed in any event; 
:#Removal of italic (<code><nowiki>''</nowiki></code>) or bold (<code><nowiki>'''</nowiki></code>) wikimarkup in: <code style="color:inherit; border:inherit; padding:inherit; background:inherit">|&lt;param>{{var|n}}=</code></span> publisher and periodical parameters.

=== ''CITE name'' function ===
This function attempts to generate unique names for citations and adds "name=<string>" to the <nowiki><ref></nowiki> tag. The unique name is generated in two possible ways and in the following order:
# The regex searches the url of the citation for the first numerical string of 6 digits or more, and '''suffixes''' it with the domain name.
# The regex looks up the {{para|date}} within the url of the citation and '''suffixes''' it to the domain name in the format; it further appends the first "word" (alphabetical string) found after the date string such that the string is <code><domainname>yyyymmmdd-<word></code>.

It will therefore not work if no unique identifier strings or dates can be found.

When faced with citations without names where the {{para|date}} is populated, the script will prefix the domain name with the date

=== ''Fill DOMAIN_NAME'' function ===
*The regex looks at the url, extracts the domain name and populates the {{para|publisher}} field.

{{User:Ohconfucius/script/install}}

==Actions and test==
Link to script code: [[User:Ohconfucius/script/Sources.js]]

Speed of script execution may vary depending on browser. 

Should the script stall when working on large articles, press <code><continue></code> on the pop-up menu &ndash; once is usually sufficient.   

Some examples of what the script does on its own follow: [http://en.wikipedia.org/w/index.php?title=Russell_Crowe&diff=521638249&oldid=521497445][http://en.wikipedia.org/w/index.php?title=U2&diff=521646875&oldid=520455475][http://en.wikipedia.org/w/index.php?title=David_Attenborough&diff=521770133&oldid=520928641][http://en.wikipedia.org/w/index.php?title=Rolling_blackout&diff=521786214&oldid=521772403][http://en.wikipedia.org/w/index.php?title=Prince_(musician)&diff=521803670&oldid=521803485][http://en.wikipedia.org/w/index.php?title=Alicia_Keys&diff=prev&oldid=521916244][http://en.wikipedia.org/w/index.php?title=Lisa_Snowdon&diff=522151991&oldid=522151919][http://en.wikipedia.org/w/index.php?title=Justin_Welby&diff=522261610&oldid=522259399][http://en.wikipedia.org/w/index.php?title=Syrian_civil_war&diff=prev&oldid=522476125][http://en.wikipedia.org/w/index.php?title=United_States_Congress&diff=523130707&oldid=523130174][http://en.wikipedia.org/w/index.php?title=Leonardo_DiCaprio&diff=prev&oldid=525158679][http://en.wikipedia.org/w/index.php?title=Hassan_Nasrallah&diff=525491230&oldid=525490968]<p>
Once you are in edit mode, there are [FOUR] buttons from this script in the toolbox in the left margin:
#'Fix SOURCES' ('New source module' in the current version);
#'Add REFTAGS' (Insert missing ref tags – use when the article contains bare urls);
#'CITE name' (gives names to all citations) 
#'Fill DOMAIN_NAME' (imports domain names to publisher field; requires the existence of an empty {{para|publisher}})

===Known limitations or contraindications===
#The script renames certain parameters so duplications may occur, for example with aliases. (see the citations in [http://en.wikipedia.org/w/index.php?title=Burlesque_(2010_musical_film)&diff=521966296&oldid=520511510 1], [http://en.wikipedia.org/w/index.php?title=All_I_Want_for_Christmas_Is_You_%28Mariah_Carey_song%29&action=edit&oldid=521740636 2] and [http://en.wikipedia.org/w/index.php?title=Because_of_You_%28Kelly_Clarkson_song%29&action=edit&oldid=521651339 3], [http://en.wikipedia.org/w/index.php?title=User:Ohconfucius/sandbox&diff=523113199&oldid=523111477 4] for example)
#Journals with similar or shared names may cause false negatives: for example, where journals differ only in the definite article in the name, the script may fail to detect and correct (e.g. ''[[The Daily Star (Lebanon)|The Daily Star]]'' vs ''[[Daily Star (United Kingdom)|Daily Star]]'').
#a publication (using {{para|publisher}}) which was italicised may lose italicisation due to automatic removal of the toggle if it is not included in the dictionary of journals and periodicals within the script.

===Disclaimer===
Users are expected to exercise careful judgement in the context of each article in which they run this script. Use at your own risk and make sure you check the edit changes before you save. It's not my fault if someone misuses this script.

===Test page===
*[[User:Ohconfucius/script/Sources/test]] (Year-2020 version). 
*[[User:Ohconfucius/test/Sourcestest]]

== See also ==
*[[Help:Citation Style 1]]
*[[Template:Citation Style documentation]]
*[[Wikipedia:WikiProject User scripts/Scripts]]