Difference between revisions of "Template:Arxiv/doc"

From blackwiki
Jump to navigation Jump to search
(Reverted doc change; couldn't make the template work due to lack of m:StringFunctions.)
m (41 revisions imported)
 
(38 intermediate revisions by 30 users not shown)
Line 1: Line 1:
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
+
<noinclude>{{Documentation subpage}}</noinclude>
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 +
{{info|1=This template is intended for [[Wikipedia:External links|external links]].  It is not designed for use as a [[Wikipedia:Citation templates|citation template]] for reliable sources.  Please consider using {{tlx|Cite arXiv}} for citations.}}
  
 
== Purpose ==
 
== Purpose ==
 +
Provides a uniform method of formatting [[arXiv]] links, and makes it simpler to update if the format of those links changes in future.
  
Provides a uniform method of formatting [[ArXiv.org e-print archive|arXiv]] links, and makes it simpler to update if the format of those links changes in future.
+
== Usage ==
 +
This template can be used in the following ways:
 +
* {{kbd|{{Make code|<<arXiv!''0123456''>>}}}}
 +
* {{kbd|{{Make code|<<arXiv!id{{=}}''0123456''>>}}}}
 +
 
 +
The parameters have the following meaning:
 +
* {{para|1}} or {{para|id}} or specifies the ID of the particular entry
  
== Usage ==
+
=== Examples ===
 +
{{Automarkup
 +
|{{Make code|<<arXiv!cs/0005003>>}}
 +
|{{Make code|<<arXiv!id{{=}}cs/0005003>>}}
 +
|{{Make code|<<arXiv!0704.0001>>}}
 +
|{{Make code|<<arXiv!id{{=}}0704.0001>>}}
 +
|{{Make code|<<arXiv!1501.00492>>}}
 +
|{{Make code|<<arXiv!id{{=}}1501.00492>>}}
 +
}}
 +
 
 +
{{cs1}} and {{cs2}} templates include a {{para|arxiv}} parameter with the same function.
 +
 
 +
== Deprecated usage ==
 +
* {{kbd|{{Make code|<<arXiv!''arch-ive''!''0123456''>>}}}}
 +
* {{kbd|{{Make code|<<arXiv!archive{{=}}''arch-ive''!id{{=}}''0123456''>>}}}}
  
This template can be used in the following ways:
+
These calling sequences were used for before 1 April 2007 when the new identifiers that removed the archive class from the identifiers themselves.
* <tt><nowiki>{{</nowiki> arxiv | archive=''arch-ive'' | id=''0123456'' }}</tt>
 
* <tt><nowiki>{{</nowiki> arxiv | ''arch-ive'' | ''0123456'' }}</tt>
 
* <tt><nowiki>{{</nowiki> arxiv | id=''0123456'' }}</tt>
 
* <tt><nowiki>{{</nowiki> arxiv | ''0123456'' }}</tt>
 
  
The first two calling sequence are to be used for old-style identifiers (i.e., those before [[1 April]] [[2007]]), while the latter two are for newer papers (after [[31 March]] [[2007]]).
+
The older entries can still be linked to by removing the delimiting "." and subject class or category specifier from the identifier and delimiting the remaining archive specifier and the rest of the identifier (the dated entry number) with a slash ("/").
  
 
The parameters have the following meaning:
 
The parameters have the following meaning:
* '''archive''' specifies the [[arXiv]] archive (full list [http://arxiv.org/help/archive_list here]) using the abbreviated code
+
* {{para|1}} or {{para|archive}} specifies the [[arXiv]] archive (full list [https://arxiv.org/help/archive_list here]) using the abbreviated code
* '''id''' specifies the ID of the particular entry
+
* {{para|2}} or {{para|id}} specifies the ID of the particular entry
  
== Example ==
+
{{Automarkup
{| class="wikitable"
+
|{{Make code|<<arXiv!cs.DL!0005003>>}}
! Code
+
|{{Make code|<<arXiv!archive{{=}}cs.DL!id{{=}}0005003>>}}
! Result
+
}}
|-
 
| <code><nowiki>
 
{{arxiv|archive=cs.DL|id=0005003}}
 
</nowiki></code>
 
|| {{arxiv|archive=cs.DL|id=0005003}}
 
|-
 
| <code><nowiki>
 
{{arxiv|cs.DL|0005003}}
 
</nowiki></code>
 
|| {{arxiv|cs.DL|0005003}}
 
|-
 
| <code><nowiki>
 
{{arxiv|id=0704.0001}}
 
</nowiki></code>
 
|| {{arxiv|id=0704.0001}}
 
|-
 
| <code><nowiki>
 
{{arxiv|0704.0001}}
 
</nowiki></code>
 
|| {{arxiv|0704.0001}}
 
|}
 
  
<includeonly>
+
== See also ==
 +
*{{tl|biorxiv}}
 +
*{{tl|Cite arXiv}}
 +
*{{tl|Catalog lookup link}}
 +
 
 +
<includeonly>{{sandbox other|1=<!-- keep sandbox out of categories -->|2=
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
[[Category:External link templates|{{PAGENAME}}]]
 
[[Category:External link templates|{{PAGENAME}}]]
 
+
[[Category:Mathematics source templates|{{PAGENAME}}]]
<!-- ADD INTERWIKIS BELOW THIS LINE -->
+
[[Category:Catalog lookup templates|{{PAGENAME}}]]
 
+
}}</includeonly>
</includeonly>
 

Latest revision as of 15:15, 28 October 2020

Purpose

Provides a uniform method of formatting arXiv links, and makes it simpler to update if the format of those links changes in future.

Usage

This template can be used in the following ways:

The parameters have the following meaning:

  • |1= or |id= or specifies the ID of the particular entry

Examples

Markup Renders as
[[:Template:MultiReplace]]
[[:Template:MultiReplace]]
[[:Template:MultiReplace]]
[[:Template:MultiReplace]]
[[:Template:MultiReplace]]
[[:Template:MultiReplace]]

Citation Style 1 and Citation Style 2 templates include a |arxiv= parameter with the same function.

Deprecated usage

These calling sequences were used for before 1 April 2007 when the new identifiers that removed the archive class from the identifiers themselves.

The older entries can still be linked to by removing the delimiting "." and subject class or category specifier from the identifier and delimiting the remaining archive specifier and the rest of the identifier (the dated entry number) with a slash ("/").

The parameters have the following meaning:

  • |1= or |archive= specifies the arXiv archive (full list here) using the abbreviated code
  • |2= or |id= specifies the ID of the particular entry

Markup Renders as
[[:Template:MultiReplace]]
[[:Template:MultiReplace]]

See also