Template:JCW-Main/doc

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

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, 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, would display an additional navbox with all the "J" subpages of the compilation, below the main navbox. This is automatically used by JL-Bot.
 * Foobar – where  corresponds to.

JCW-PrevNext
Uses to generate the footer navbox. All of the above parameters are automatically used by JL-Bot.
 * previous
 * current
 * next

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.
 * rank – Set to   to display the rank in WP:JCW/POP and WP:JCW/MIS.

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
Creates rows in WP:JCW/ALPHA, WP:JCW/POP, WP:JCW/MIS Both display-type and target-type accept the type codes on the right. All of the above parameters are automatically used by JL-Bot.
 * 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).

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. JCW-bottom-common‎, JCW-bottom-questionable‎, JCW-bottom-publishers‎ are additional helper templates to reduce the number of minor page changes.
 * type – Can be set to   to suppress the Type section.
 * legend – Can be set to  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-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.

JCW-selected/JCW-exclude
Used in WP:CITEWATCH/SETUP / WP:JCW/PUBSETUP to tell JL-Bot what to look for to produce WP:CITEWATCH / WP:JCW/PUB. The format is The templates must be on a single line, and doi, source and note parameters must but at the end of the template.

JCW-selected 'selects' targets, which may be categories, articles, or sources with a specific doi prefix. For example would 'select' And consolidate those under a Hindawi Publishing Corporation entry. source can be used to specify why an entry appears on WP:CITEWATCH while note is a general parameter to add notes to an entry, like specific considerations for a certain entry or publisher.
 * Hindawi Publishing Corporation
 * All entries in Category:Hindawi Publishing Corporation academic journals
 * J Cancer Res + J. Cancer Res. + Journal of Cancer Research + The Journal of Cancer Research
 * All redirects to such those pages
 * All citation with the doi prefixes  and

JCW-exclude can then be used to forcibly exclude things that would otherwise match the above selections. For example Tells the bot that 'Int. J. Urol.' should not be included under the Hindawi Publishing Corporation entry.

JCW-pattern
Used in WP:CITEWATCH/SETUP / WP:JCW/PUBSETUP / WP:JCW/PATSETUP to tell JL-Bot what to look for to produce WP:CITEWATCH / WP:JCW/PUB / WP:JCW/PAT. The format is

JCW-pattern 'selects' targets based on specific patterns and antipatterns. For example would 'select' And consolidate those under a American Society of Civil Engineers entry.
 * All citations with 'ACSE' appearing somewhere in journal
 * But exclude those with 'Ascen' or 'Ascet' in it

Both  and   are equivalent to the regex   ('match anything'), but   tells the bot to include the pattern, while   tells the bot to exclude it.

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-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 , customizes the disclaimer for WP:CITEWATCH/SETUP specifically.

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 , customizes the disclaimer for WP:JCW/PUBSETUP specifically.

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.
 * source – The same as source found in the JCW-selected entries of WP:CITEWATCH/SETUP.
 * note – The same as note found in the JCW-selected entries of WP:CITEWATCH/SETUP.