Template:JCW-Letter/doc
 | This is a documentation subpage for Template:JCW-Letter. It may contain usage information, categories and other content that is not part of the original template page. |
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
[edit]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=Jwould 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}}
[edit]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– whereFoobarcorresponds toWikipedia:WikiProject Academic Journals/Journals cited by Wikipedia/Foobar#.
This is automatically used by JL-Bot.
{{JCW-PrevNext}}
[edit]Uses
|previous=|current=|next=
to generate the footer navbox. All of the above parameters are automatically used by JL-Bot.
Tables
[edit]Starts the top of the table on pages like WP:JCW/ALPHA, WP:JCW/POP, WP:JCW/MIS.
|rank=– Set toYesto display the rank in WP:JCW/POP and 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.
- 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}}
[edit]Ends the bottom of the table on pages like WP:JCW/ALPHA, WP:JCW/POP, WP:JCW/MIS.
|type=– Can be set tonoto suppress the Type section.|legend=– Can be set tonoto 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.
Generates the 'type' footnote at the bottom of the compilation. Automatically called by {{JCW-bottom}}.
{{JCW-legend}}
[edit]Generates the 'legend' footnote at the bottom of the compilation. Automatically called by {{JCW-bottom}}.
Selection templates
[edit]{{JCW-selected}}/{{JCW-exclude}}
[edit]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
{{JCW-selected|<TARGET1>|<TARGET2>|...|doi=...|source=...|note=...}}{{JCW-exclude|<TARGET>|<EXCLUSION>}}
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
{{JCW-selected|Hindawi Publishing Corporation|Category:Hindawi Publishing Corporation academic journals|J Cancer Res|J. Cancer Res.|Journal of Cancer Research|The Journal of Cancer Research|doi1=10.1155|doi2=10.5402}}
would 'select'
- 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
10.1155and10.5402
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.
{{JCW-exclude}} can then be used to forcibly exclude things that would otherwise match the above selections. For example
{{JCW-exclude|Hindawi Publishing Corporation|Int. J. Urol.|c=19}}
Tells the bot that 'Int. J. Urol.' should not be included under the Hindawi Publishing Corporation entry.
{{JCW-pattern}}
[edit]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|<TARGET>|<PATTERN1>|<PATTERN2>|...|<ANTIPATTERN1>|<ANTIPATTERN2>|...}}
{{JCW-pattern}} 'selects' targets based on specific patterns and antipatterns. For example
{{JCW-pattern|American Society of Civil Engineers|.*ASCE.*|!Ascen!|!Ascet!}}
would 'select'
- All citations with 'ACSE' appearing somewhere in
|journal= - But exclude those with 'Ascen' or 'Ascet' in it
And consolidate those under a American Society of Civil Engineers entry.
Both .* and ! are equivalent to the regex .* ('match anything'), but .* tells the bot to include the pattern, while ! tells the bot to exclude it.
Other
[edit]Used to mark a WP:JCW/TAR subpage as 'cleaned', most often by JCW-CleanerBot (or its operator Headbomb). Produces the below banner.
 | The entries featured on this page have all been cleaned up (e.g. Science (New York, N.Y.) → Science) or standardized (e.g. New England journal of medicine → New England Journal of Medicine ). No further cleanup efforts are needed for the entries found on this page until the next compilation update, after which this notice will be automatically be removed. |
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.
Automatically invoked by {{JCW-Main}} to generate the disclaimer at the top of WP:CITEWATCH and WP:CITEWATCH/SETUP.
|config=– When set toyes, customizes the disclaimer for WP:CITEWATCH/SETUP specifically.
Automatically invoked by {{JCW-Main}} to generate the disclaimer at the top of WP:JCW/PUB and WP:JCW/PUBSETUP.
|config=– When set toyes, customizes the disclaimer for WP:JCW/PUBSETUP specifically.
{{JCW-selected-source}}
[edit]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.