Difference between revisions of "Template:PLASingleFile"

From Planck Legacy Archive Wiki
Jump to: navigation, search
 
(35 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
This is the documentation
+
==Description==
</noinclude>
+
Template <tt>PLASingleFile</tt> produces a link to a single file in the PLA.
<includeonly>[http://pladev.esac.esa.int/pla/aio/product-action?{{#switch: {{{fileType}}}
+
==Use==
 +
<pre>
 +
{{PLASingleFile|fileType=aFileType|name=aName|link=linkText}}
 +
</pre>
 +
where the allowed values for the parameters are as follows
 +
; <tt>fileType</tt>
 +
: <tt>map</tt> ''(for maps)''
 +
: <tt>cat</tt> ''(for catalogues)''
 +
: <tt>catdoc</tt> ''(for catalogue associated files)''
 +
: <tt>cosmo</tt> ''(for cosmology files)''
 +
: <tt>anci</tt> ''(for ancillary files)''
 +
: <tt>posh</tt> ''(for the POSH)''
 +
: <tt>docu</tt> (''for documents)''
 +
; <tt>name</tt>
 +
: the file name as provided to the PLA by the DPCs
 +
; <tt>link</tt>
 +
: the text you would like to appear on your link.
 +
==Examples==
 +
===Download a map===
 +
'''What you type'''
 +
<pre>
 +
{{PLASingleFile|fileType=map|name=COM_CompMap_CMB-nilc_2048_R1.20.fits|link=A map}}
 +
</pre>
 +
'''How it appears'''
 +
 
 +
{{PLASingleFile|fileType=map|name=COM_CompMap_CMB-nilc_2048_R1.20.fits|link=A map}}
 +
 
 +
===Download a catalogue===
 +
'''What you type'''
 +
<pre>
 +
{{PLASingleFile|fileType=cat|name=ERCSC_f353.fits|link=A Catalogue}}
 +
</pre>
 +
 
 +
'''How it appears'''
 +
 
 +
{{PLASingleFile|fileType=cat|name=ERCSC_f353.fits|link=A Catalogue}}
 +
===Download a power spectrum===
 +
'''What you type'''
 +
<pre>
 +
{{PLASingleFile|fileType=cosmo|name=COM_PowerSpect_CMB_R1.10.fits|link=A spectrum}}
 +
</pre>
 +
 
 +
'''How it appears'''
 +
 
 +
{{PLASingleFile|fileType=cosmo|name=COM_PowerSpect_CMB_R1.10.fits|link=A spectrum}}
 +
 
 +
===Download the RIMO===
 +
'''What you type'''
 +
<pre>
 +
{{PLASingleFile|fileType=rimo|name=HFI_RIMO_R1.10.fits|link=The HFI RIMO}}
 +
</pre>
 +
 
 +
'''How it appears'''
 +
 
 +
{{PLASingleFile|fileType=rimo|name=HFI_RIMO_R1.10.fits|link=The HFI RIMO}}
 +
</noinclude><includeonly>[{{PLAurl|type=product}}{{#switch: {{{fileType}}}
 
| map=MAP.MAP_ID
 
| map=MAP.MAP_ID
 
| cat=SOURCE_LIST.NAME
 
| cat=SOURCE_LIST.NAME
 +
| catdoc=DOCUMENT_SOURCE_LIST.DOCUMENT_ID
 
| cosmo=COSMOLOGY.FILE_ID
 
| cosmo=COSMOLOGY.FILE_ID
 
| anci=ANCILLARY_DATA.FILE_ID
 
| anci=ANCILLARY_DATA.FILE_ID
Line 10: Line 66:
 
| posh=POSH.POSH_VERSION
 
| posh=POSH.POSH_VERSION
 
| file=FILE.FILE_ID
 
| file=FILE.FILE_ID
| docu=DOCUMENT.DOCUMENT_ID
+
| rimo=DOCUMENT_MAP.DOCUMENT_ID
 
}}={{{name}}} {{{link}}}]</includeonly>
 
}}={{{name}}} {{{link}}}]</includeonly>

Latest revision as of 13:24, 31 July 2013

Description[edit]

Template PLASingleFile produces a link to a single file in the PLA.

Use[edit]

{{PLASingleFile|fileType=aFileType|name=aName|link=linkText}}

where the allowed values for the parameters are as follows

fileType
map (for maps)
cat (for catalogues)
catdoc (for catalogue associated files)
cosmo (for cosmology files)
anci (for ancillary files)
posh (for the POSH)
docu (for documents)
name
the file name as provided to the PLA by the DPCs
link
the text you would like to appear on your link.

Examples[edit]

Download a map[edit]

What you type

{{PLASingleFile|fileType=map|name=COM_CompMap_CMB-nilc_2048_R1.20.fits|link=A map}}

How it appears

A map

Download a catalogue[edit]

What you type

{{PLASingleFile|fileType=cat|name=ERCSC_f353.fits|link=A Catalogue}}

How it appears

A Catalogue

Download a power spectrum[edit]

What you type

{{PLASingleFile|fileType=cosmo|name=COM_PowerSpect_CMB_R1.10.fits|link=A spectrum}}

How it appears

A spectrum

Download the RIMO[edit]

What you type

{{PLASingleFile|fileType=rimo|name=HFI_RIMO_R1.10.fits|link=The HFI RIMO}}

How it appears

The HFI RIMO

Planck Legacy Archive

Cosmic Microwave background

Early Release Compact Source Catalog

reduced IMO

(Planck) High Frequency Instrument