View source for Template:Picdic/documentation

{{documentation subpage}}
Use this template to add a [[Project:Picture dictionary|Picture dictionary]] to an entry.

'''Usage''' (see four different ways to use this template below):

{{ picdic
| image=Solar_sys8.jpg
| text=Solar System
| width=200
| detail1=
{{ picdicimg |en| image=Milky Way Galaxy.jpg | link=heavenly body }}
| detail2=
{{ picdicimg |en| image=Celestia sun.jpg | link=Sun | altlink=The sun }}
{{ picdicimg |en| image=Mercury in color - Prockter07 centered.jpg | link=Mercury }}
}}

<div style="font-size:9px; background:#EEEEEE;">
<nowiki>{{ </nowiki>'''picdic'''<br>
<nowiki>| image=Solar_sys8.jpg</nowiki><br>
<!-- <nowiki>| text=Solar System</nowiki><br> -->
<nowiki>| detail1=</nowiki>
:<nowiki>{{ picdicimg | image=Milky Way Galaxy.jpg | link=heavenly body |lang=en}}</nowiki><br>
<nowiki>| detail2=</nowiki><br>
:<nowiki>{{ picdicimg | image=Celestia sun.jpg | link=Sun | altlink=The sun |lang=en}}</nowiki><br>
:<nowiki>{{ picdicimg | image=Mercury in color - Prockter07 centered.jpg | link=Mercury |lang=en}}</nowiki><br>
<nowiki>}}</nowiki>
</div>

'''Parameters''' for this template:
;image
:Image that describes the entry.
;detail1
: Any content, in most cases clickable image(s) describing a {{wt|hypernym}}.
: A clickable image can be inserted by adding a line with [[template:picdicimg]] for each image.

'''Optional parameters'''
;detail2
;detail3
;detail4
: Any content, in most cases clickable images describing the {{wt|hyponym}}s.
: A clickable image can be inserted by adding a line with [[template:picdicimg]] for each image.
: detail2, detail3 and detail4 are optional, in that case {{wt|hyponym}}s should be described elsewhere.
: Within parameters detail1, detail2, detail3 and detail4 the full wiki syntax can be used. The only restriction is the use of the <nowiki>|</nowiki> character in tables (and complex templates). That character should be replaced by the template <nowiki>{{!}}</nowiki>. For tables <nowiki>{|, |-, |, ||, |} etc. should be replaced by {{{!}}, {{!}}-, {{!}}, {{!}}{{!}}, {{!}}} etc. </nowiki> Alternatively the [[Wikipedia:Help:Table#Other_table_syntax|(X)HTML syntax for tables]] can be used like &lt;table>&lt;tr>&lt;td> &lt;/td>&lt;/tr>&lt;/table>.
;scrollable
: Fill scrollable=yes to have a scroll bar at the bottom of the details
;text
:The name of the entry. The default value is the page name of the entry.
;width
:Maximum width of the image.
:This parameter is optional, the default width is 310.
;height
:Maximum height of the image.
:This parameter is optional, the default height is 310.
;imagemap
: This parameter is optional, and only to be used in case of an image map instead of other visual content describing the {{wt|hyponym}}s.
: The parameter imagemap cannot be used in combination with the parameter labels
: To use image maps this parameter should be filled with a valid defintion of the imagemap areas.
: The coordinates are the number of pixels from the upper-left-hand corner of the default size of the image, so are '''independent''' of the size shown on screen.
: Example of this parameter:
<div style="font-size:9px; background:#EEEEEE;">
::imagemap=
::<nowiki>circle 1035 572 13 {{wt|Mercury}}</nowiki>
::<nowiki>circle 860 483 234 {{wt|Sun}}</nowiki>
</div>
: A tutorial to use image maps can be found at [[:w:Wikipedia:Wikipedia Signpost/2008-03-03/Tutorial|Wikipedia:Wikipedia Signpost/2008-03-03]].
;labels
: This parameter is optional, and only to be used in case of text labels to be inserted on the main image instead of other visual content describing the {{wt|hyponym}}s.
: The parameter labels cannot be used in combination with the parameter imagemap
: The labels itself should be inserted by adding a line with [[template:picdiclabel]] for each label.
: The coordinates are the number of pixels from the upper-left-hand corner of the visible size of the image, so are '''dependent''' of the size shown on screen. See the template for further info.
: Examples of this parameter:
<div style="font-size:9px; background:#EEEEEE;">
::labels=
::<nowiki>{{</nowiki> picdiclabel | posx=181 | posy= 86 | link=Sun |lang=en}}
::<nowiki>{{</nowiki> picdiclabel | posx=214 | posy=119 | link=Mercury | style="text-align:right;" |lang=en}}
</div>

=== Examples ===

Four different ways to use [[Project:Picture dictionary | Picture dictionary]] (using [[Template:picdic]]), {{wt|Solar System}} examples with comparable links.
{|
|-
| style="vertical-align:top;" |
''' Picture dictionary with clickable images '''
| style="vertical-align:top;" |
''' Picture dictionary with legend and wikilinks '''
| style="vertical-align:top;" |
''' Picture dictionary with image map '''
| style="vertical-align:top;" |
''' Picture dictionary with labels '''
|-
| style="vertical-align:top;" |
{{ picdic
| image=Solar_sys8.jpg
| text=Solar System
| detail1=
{{ picdicimg |en| image=Milky Way Galaxy.jpg | link=heavenly body }}
| detail2=
{{ picdicimg |en| image=Celestia sun.jpg | link=Sun | altlink=The sun }}
{{ picdicimg |en| image=Mercury in color - Prockter07 centered.jpg | link=Mercury }}
{{ picdicimg |en| image=Venus-real color.jpg | link=Venus }}
{{ picdicimg |en| image=The Earth seen from Apollo 17.jpg | link=Earth }}
{{ picdicimg |en| image=Full Moon Luc Viatour.jpg | link=Moon }}
{{ picdicimg |en| image=Mars Hubble.jpg | link=Mars }}
{{ picdicimg |en| image=Jupiter_by_Cassini-Huygens.jpg | link=Jupiter }}
{{ picdicimg |en| image=Saturn - Lord of the Rings.jpg | link=Saturn }}
{{ picdicimg |en| image=Uranus2.jpg | link=Uranus }}
{{ picdicimg |en| image=Neptune.jpg | link=Neptune }}
{{ picdicimg |en| image=Comet_Hale-Bopp_1995O1.jpg | link=comet }}
{{ picdicimg |en| image=951 Gaspra.jpg | link=asteroid belt }}
{{ picdicimg |en| image=Kepler's law 2 en.svg | link=orbit }}
}}

| style="vertical-align:top;" |
{{ picdic
| image=Solar sys8 numbered.jpg
| text=Solar System
| detail1=
{{ picdicimg |en| image=Milky Way Galaxy.jpg | link=heavenly body }}
| detail2=
'''Legend (1):'''<br/>
1= [[Sun#English | The sun]]
2= [[Mercury#English | Mercury]]
3= [[Venus#English | Venus]]
4= [[Earth#English | Earth]]
5= [[Moon#English | Moon]]
6= [[Mars#English | Mars]]
7= [[Jupiter#English | Jupiter]]
8= [[Saturn#English | Saturn]]
9= [[Uranus#English | Uranus]]
10= [[Neptune#English | Neptune]]
11= [[comet#English | comet]]
12= [[asteroid belt#English | asteroid belt]]
13= [[orbit#English | orbit]]
14= [[terrestrial planet#English | terrestrial planets]] or [[inner planet#English | inner planets]]
15= [[outer planet#English | outer planets]]
| detail3=<!-- alternative 2 -->
'''Legend (2):'''<br/>
1= [[Sun#English | The sun]]<br>
2= [[Mercury#English | Mercury]]<br>
3= etc
| detail4=<!-- alternative 3 -->
{{{!}} <!-- table -->
{{!}}-
{{!}} colspan=3 {{!}} '''Legend (3, in table):'''<br/>
{{!}}-
{{!}} valign = top {{!}}
1= [[Sun#English | The sun]]<br>
2= [[Mercury#English | Mercury]]<br>
3= [[Venus#English | Venus]]<br>
4= [[Earth#English | Earth]]<br>
5= [[Moon#English | Moon]]
{{ ! }} valign = top {{ ! }}
6= [[Mars#English | Mars]]<br>
7= [[Jupiter#English | Jupiter]]<br>
8= [[Saturn#English | Saturn]]<br>
9= [[Uranus#English | Uranus]]<br>
10= [[Neptune#English | Neptune]]
{{ ! }} valign = top {{ ! }}
11= [[comet#English | comet]]<br>
12= [[asteroid belt#English | asteroid belt]]<br>
13= [[orbit#English | orbit]]<br>
14= [[terrestrial planet#English | terrestrial planets]]<br>or [[inner planet#English | inner planets]]<br>
15= [[outer planet#English | outer planets]]
{{!}}} <!-- end of table -->

}}

| style="vertical-align:top;" |
{{ picdic
| image=Solar_sys8.jpg
| text=Solar System
| imagemap=
circle  226 106  22 [[Neptune#English | Neptune]]
circle  305 124  26 [[Uranus#English | Uranus]]
circle  525 202  49 [[Jupiter#English | Jupiter]]
circle  401 147  32 [[Saturn#English | Saturn]]
circle 1035 572  13 [[Mercury#English | Mercury]]
circle  860 483 234 [[Sun#English | The sun]]
circle 1141 531  28 [[Venus#English | Venus]]
circle 1236 479  28 [[Earth#English | Earth]]
circle 1342 398  24 [[Mars#English | Mars]]
circle 1277 460   9 [[Moon#English | Moon]]
rect  39 400 196 430 [[comet#English | comet]]
rect 216 538 458 903 [[asteroid belt#English | asteroid belt]]
| detail1=Click on parts of the image
| detail2=
{{ picdicimg |en| image=Milky Way Galaxy.jpg | link=heavenly body }}
}}

| style="vertical-align:top;" |
{{ picdic
| image=Solar_sys8.jpg
| text=Solar System
| width=310
| labels=
{{ picdiclabel |en| color=white | fontsize=18 | posx=181 | posy= 86 | link=Sun | altlink=The sun }}
{{ picdiclabel |en| color=white | fontsize=12 | posx=214 | posy=119 | link=Mercury | style="text-align:right;" }}
{{ picdiclabel |en| color=white | fontsize=12 | posx=237 | posy=105 | link=Venus | style="text-align:right;" }}
{{ picdiclabel |en| color=white | fontsize=12 | posx=257 | posy= 94 | link=Earth | style="text-align:right;" }}
{{ picdiclabel |en| color=white | fontsize=12 | posx=281 | posy= 82 | link=Moon | style="text-align:right;" }}
{{ picdiclabel |en| color=white | fontsize=12 | posx=297 | posy= 68 | link=Mars | style="text-align:right;" }}
{{ picdiclabel |en| color=white | fontsize=12 | posx=121 | posy= 60 | link=Jupiter | style="text-align:right;" }}
{{ picdiclabel |en| color=white | fontsize=12 | posx= 86 | posy= 44 | link=Saturn | style="text-align:right;" }}
{{ picdiclabel |en| color=white | fontsize=12 | posx= 57 | posy= 31 | link=Uranus | style="text-align:right;" }}
{{ picdiclabel |en| color=white | fontsize=12 | posx= 55 | posy= 5 | link=Neptune | style="text-align:right;" }}
{{ picdiclabel |en| color=white | fontsize=12 | posx= 26 | posy= 95 | link=comet }}
{{ picdiclabel |en| color=white | fontsize=12 | posx= 65 | posy=181 | link=asteroid belt }}
{{ picdiclabel |en| color=white | fontsize=12 | posx=112 | posy=164 | link=orbit }}
| detail1=Click on labels in the image
| detail2=
{{ picdicimg |en| image=Milky Way Galaxy.jpg | link=heavenly body }}
}}

|- <!-- codes -->
| style="vertical-align:top;" |
'''Code:'''<br>
<div style="font-size:9px; background:#EEEEEE;">
<nowiki>{{ picdic</nowiki><br>
<nowiki>| image=Solar_sys8.jpg</nowiki><br>
<!-- <nowiki>| text=Solar System</nowiki><br> -->
<nowiki>| detail1=</nowiki>
:<nowiki>{{ picdicimg | image=Milky Way Galaxy.jpg | link=heavenly body |lang=en}}</nowiki><br>
<nowiki>| detail2=</nowiki><br>
:<nowiki>{{ picdicimg | image=Celestia sun.jpg | link=Sun | altlink=The sun |lang=en}}</nowiki><br>
:<nowiki>{{ picdicimg | image=Mercury in color - Prockter07 centered.jpg | link=Mercury |lang=en}}</nowiki><br>
: etc.<br>
<nowiki>}}</nowiki>
</div>
| style="vertical-align:top;" |
'''Code:'''<br>
<div style="font-size:9px; background:#EEEEEE;">
<nowiki>{{ picdic</nowiki><br>
<nowiki>| image=Solar sys8 numbered.jpg</nowiki><br>
<!-- <nowiki>| text=Solar System</nowiki><br> -->
<nowiki>| detail1=</nowiki><br>
:<nowiki>{{ picdicimg | image=Milky Way Galaxy.jpg | link=heavenly body |lang=en}}</nowiki><br>
<nowiki>| detail2=</nowiki>
:<nowiki>'''Legend (1):'''<br/></nowiki>
:<nowiki>1= [[Sun#English | The sun]]</nowiki>
:<nowiki>2= [[Mercury#English | Mercury]]</nowiki>
:<nowiki>3= etc</nowiki><br>
<nowiki>}}</nowiki>
</div>
| style="vertical-align:top;" |
'''Code:'''<br>
<div style="font-size:9px; background:#EEEEEE;">
<nowiki>{{ picdic</nowiki><br>
<nowiki>| image=Solar_sys8.jpg</nowiki><br>
<!-- <nowiki>| text=Solar System</nowiki><br> -->
<nowiki>| imagemap=</nowiki><br>
:<nowiki>circle 1035 572  13 [[Mercury#English | Mercury]]</nowiki><br>
:<nowiki>circle  860 483 234 [[Sun#English | The sun]]</nowiki><br>
: etc<br>
<nowiki>| detail1=Click on parts of the image</nowiki><br>
<nowiki>| detail2=</nowiki>
:<nowiki>{{ picdicimg | image=Milky Way Galaxy.jpg | link=heavenly body |lang=en}}</nowiki><br>
<nowiki>}}</nowiki>
</div>
| style="vertical-align:top;" |
'''Code:'''<br>
<div style="font-size:9px; background:#EEEEEE;">
<nowiki>{{ picdic</nowiki><br>
<nowiki>| image=Solar_sys8.jpg</nowiki><br>
<!-- <nowiki>| text=Solar System</nowiki><br> -->
<nowiki>| width=310</nowiki><br>
<nowiki>| labels=</nowiki>
:<nowiki>{{ picdiclabel | color=white | fontsize=18 | posx=181 | posy= 86 | link=Sun | altlink=The sun |lang=en}}</nowiki>
:<nowiki>{{ picdiclabel | color=white | fontsize=12 | posx=214 | posy=119 | link=Mercury | style="text-align:right;" |lang=en}}</nowiki>
: etc.
<nowiki>| detail1=Click on labels in the image</nowiki><br>
<nowiki>| detail2=</nowiki>
:<nowiki>{{ picdicimg | image=Milky Way Galaxy.jpg | link=heavenly body |lang=en}}</nowiki><br>
<nowiki>}}</nowiki>
</div>
|}

[[simple:Template:picdic]]