Difference between revisions of "Template:JCW-Main/doc"

From blackwiki
Jump to navigation Jump to search
imported>Headbomb
(→‎{{tl|JCW-Citewatch-Warning}}{{anchor|JCW-Citewatch-Warning}}: ==={{tl|JCW-Publisher-Warning}}{{anchor|JCW-Citewatch-Warning}}=== Automatically invoked by {{tl|JCW-Main}} to generate the disclaimer at the top of WP:JCW/PUB and WP:JCW/PUBSETUP. *{{para|config}} – When set to <code>yes</code>, customizes the disclaimer for WP:JCW/PUBSETUP specifically.)
imported>Headbomb
(other)
Line 64: Line 64:
 
==={{tl|JCW-legend}}{{anchor|JCW-legend}}===
 
==={{tl|JCW-legend}}{{anchor|JCW-legend}}===
 
Generates the [[Wikipedia:WikiProject Academic Journals/Journals cited by Wikipedia/A1#Legend|'legend' footnote]] at the bottom of the compilation. Automatically called by {{tl|JCW-bottom}}.
 
Generates the [[Wikipedia:WikiProject Academic Journals/Journals cited by Wikipedia/A1#Legend|'legend' footnote]] at the bottom of the compilation. Automatically called by {{tl|JCW-bottom}}.
 +
 +
==Other==
 +
==={{tl|JCW-Publisher-Warning}}{{anchor|JCW-Publisher-Warning}}===
 +
Automatically invoked by {{tl|JCW-Main}} to generate the disclaimer at the top of [[WP:JCW/PUB]] and [[WP:JCW/PUBSETUP]].
 +
*{{para|config}} –  When set to <code>yes</code>, customizes the disclaimer for [[WP:JCW/PUBSETUP]] specifically.
  
 
==[[WP:JCW/TAR]]-related templates==
 
==[[WP:JCW/TAR]]-related templates==
Line 79: Line 84:
 
*<code><nowiki>{{JCW-exclude|<TARGET>|<ENTRY>}}</nowiki></code>
 
*<code><nowiki>{{JCW-exclude|<TARGET>|<ENTRY>}}</nowiki></code>
 
<code><nowiki><TARGET></nowiki></code> should match the ''Target'' column value and <code><nowiki><ENTRY></nowiki></code> should match the ''Entries'' column value that is to be excluded from future results. The template '''must''' be on a single line.
 
<code><nowiki><TARGET></nowiki></code> should match the ''Target'' column value and <code><nowiki><ENTRY></nowiki></code> should match the ''Entries'' column value that is to be excluded from future results. The template '''must''' be on a single line.
 +
  
 
==[[WP:CITEWATCH]]-related templates==
 
==[[WP:CITEWATCH]]-related templates==
Line 84: Line 90:
 
Automatically invoked by {{tl|JCW-Main}} to generate the disclaimer at the top of [[WP:CITEWATCH]] and [[WP:CITEWATCH/SETUP]].
 
Automatically invoked by {{tl|JCW-Main}} to generate the disclaimer at the top of [[WP:CITEWATCH]] and [[WP:CITEWATCH/SETUP]].
 
*{{para|config}} –  When set to <code>yes</code>, customizes the disclaimer for [[WP:CITEWATCH/SETUP]] specifically.
 
*{{para|config}} –  When set to <code>yes</code>, customizes the disclaimer for [[WP:CITEWATCH/SETUP]] specifically.
 
==={{tl|JCW-Publisher-Warning}}{{anchor|JCW-Citewatch-Warning}}===
 
Automatically invoked by {{tl|JCW-Main}} to generate the disclaimer at the top of [[WP:JCW/PUB]] and [[WP:JCW/PUBSETUP]].
 
*{{para|config}} –  When set to <code>yes</code>, customizes the disclaimer for [[WP:JCW/PUBSETUP]] specifically.
 
  
 
==={{tl|JCW-selected}}/{{tl|JCW-exclude}}{{anchor|JCW-selected}}===
 
==={{tl|JCW-selected}}/{{tl|JCW-exclude}}{{anchor|JCW-selected}}===

Revision as of 14:37, 22 November 2019

This is the documentation page for the JCW-related series of templates. Of interest to humans are #JCW-Main, #JCW-done, #JCW-exclude, and #JCW-selected. The others are automatically used by JL-Bot or automatically used by other JCW-templates when needed.

Navboxes

{{JCW-Main}}

This is the main navbox displayed on every page of the JCW compilation. It has three parameters

  • |letter= – passed to the {{JCW-Letter}} template. For example, |letter=J would display an additional navbox with all the "J" subpages of the compilation, below the main navbox. This is automatically used by JL-Bot.
  • |config= – passed to the {{JCW-Citewatch-Warning}} and {{JCW-Publisher-Warning}} templates. Only used on WP:CITEWATCH/SETUP and WP:JCW/PUBSETUP to customize the warning to the setup page, and give slightly different shortcuts.
  • |state= – to collapse/uncollapse the navbox. Uncollapsed by default.

It is automatically added by JL-Bot on the relevant pages of the compilation, but you can add this to your userpage if you want.

{{JCW-Letter}}

Invoked by {{JCW-Main}}. For example, {{JCW-Main|letter=J}} would display an additional navbox with all the "J" subpages of the compilation, below the main navbox.

  • |letter=Foobar – where Foobar corresponds to Wikipedia:WikiProject Academic Journals/Journals cited by Wikipedia/Foobar#.

This is automatically used by JL-Bot.

{{JCW-PrevNext}}

Uses

  • |previous=
  • |current=
  • |next=

to generate the footer navbox. All of the above parameters are automatically used by JL-Bot.

Tables

{{JCW-top}}

Starts the top of the table on pages like WP:JCW/ALPHA, WP:JCW/POP, WP:JCW/MIS.

This is automatically used by JL-Bot.

{{JCW-CRAP-top}}, {{JCW-TAR-top}}, {{JCW-PUB-top}} have similar functionality for WP:JCW/CRAP, WP:JCW/TAR, and WP:JCW/PUB, respectively.

{{JCW-row}}

Type
ISO : ISO 4 redirect
BB : Bluebook redirect
MATH : MathSciNet redirect
NLM : NLM redirect
J : Journal
Mag : Magazine
News : Newspaper
Web : Website
Book : Book
Data : Database
Pub : Publisher
? : Unknown

Creates rows in WP:JCW/ALPHA, WP:JCW/POP, WP:JCW/MIS

  • |rank= – Used to provide the ranking number on WP:JCW/POP, WP:JCW/MIS
  • |display= – The display name (with formatting & linking) for the 'Journal' column.
  • |display-type= – The type of publication (or publisher) of the link of the 'Journal' column
  • |target= – The target name (with formatting & linking) for the 'Target' column.
  • |target-type= – The type of publication (or publisher) of the link of the 'Target' column
  • |citations= – The number of citations for the 'Citations' column.
  • |articles= – The number of articles or the list of linked articles (if 5 or less) for the 'Articles' column.
  • |search= – A URL-encoded version of the journal name used for web search links (not using urlencode magic word due to issues with imbalanced brackets).

Both |display-type= and |target-type= accept the type codes on the right. All of the above parameters are automatically used by JL-Bot.

{{JCW-CRAP-rank}}, {{JCW-TAR-rank}}, {{JCW-PUB-rank}} have similar functionality for WP:JCW/CRAP, WP:JCW/TAR, and WP:JCW/PUB, respectively.

{{JCW-bottom}}

Ends the bottom of the table on pages like WP:JCW/ALPHA, WP:JCW/POP, WP:JCW/MIS.

  • |type= – Can be set to no to suppress the Type section.
  • |legend= – Can be set to no to suppress the Legend section.
  • |date= - Displays the date of the database dump.
  • |e-id= - Display a link to the revision id of the exclusions page.
  • |m-id= - Display a link to the revision id of the maintenance configuration page.
  • |p-id= - Display a link to the revision id of the publishers configuration page.
  • |q-id= - Display a link to the revision id of the questionable configuration page.

{{JCW-bottom-common‎}}, {{JCW-bottom-questionable‎}}, {{JCW-bottom-publishers‎}} are additional helper templates to reduce the number of minor page changes.

{{JCW-type}}

Generates the 'type' footnote at the bottom of the compilation. Automatically called by {{JCW-bottom}}.

{{JCW-legend}}

Generates the 'legend' footnote at the bottom of the compilation. Automatically called by {{JCW-bottom}}.

Other

{{JCW-Publisher-Warning}}

Automatically invoked by {{JCW-Main}} to generate the disclaimer at the top of WP:JCW/PUB and WP:JCW/PUBSETUP.

  • |config= – When set to yes, customizes the disclaimer for WP:JCW/PUBSETUP specifically.

WP:JCW/TAR-related templates

{{JCW-done}}

Used to mark a WP:JCW/TAR subpage as 'cleaned', most often by JCW-CleanerBot (or its operator Headbomb). Produces the below banner.

The absence of a banner doesn't mean that the entries have not been cleaned up (JCW-CleanerBot's operator could have forgotten to add them), but the presence of the banner indicates that you do not have to waste your time reviewing the various typos present until the next update.

{{JCW-exclude}}

Used in WP:JCW/EXCLUDE to remove false positives for matches in WP:JCW/TAR, WP:MCW/TAR, and WP:CITEWATCH. The format is

  • {{JCW-exclude|<TARGET>|<ENTRY>}}

<TARGET> should match the Target column value and <ENTRY> should match the Entries column value that is to be excluded from future results. The template must be on a single line.


WP:CITEWATCH-related templates

{{JCW-Citewatch-Warning}}

Automatically invoked by {{JCW-Main}} to generate the disclaimer at the top of WP:CITEWATCH and WP:CITEWATCH/SETUP.

  • |config= – When set to yes, customizes the disclaimer for WP:CITEWATCH/SETUP specifically.

{{JCW-selected}}/{{JCW-exclude}}

Used in WP:CITEWATCH/SETUP to tell JL-Bot what to look for to produce WP:CITEWATCH. The format is

  • {{JCW-selected|<TARGET1>|<TARGET2>|...|source=...|note=...}}

The template must be on a single line, and the |source= and |note= parameters must but at the end of the template. {{JCW-exclude}}, documented above, is used to remove the false positives.

{{JCW-selected-source}}

Automatically used by JL-Bot to take the sources and notes from WP:CITEWATCH/SETUP and put them in the corresponding entries of WP:CITEWATCH.