View source for Template:Box portal skeleton/doc

{{Documentation subpage}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
{{Intricate template}}
{{Subst only}}

== Usage ==

=== Steps ===

To create a new portal on the topic "Topic" using the {{tl|box portal skeleton}} template follow these steps:<br>

{| 
!width="50" valign="top" | 1.
| Create a new page using <nowiki>[[Portal:Topic]]</nowiki> as the title of the page (where "Topic" is the subject of your portal) and enter the following text
 <nowiki>{{subst:box portal skeleton}}</nowiki>
Save. At this point you will have a page full of red links; this is correct.
|-
!valign="top"| 2.
| Create header subpage, scroll to the bottom of the page and click the template link to the header
* Save <nowiki>[[Portal:Topic/box-header]]</nowiki> with this text (check the [[Web colors]] article if you want the code for some other color):
 <nowiki>{{Box-header | title={{{1}}}</nowiki>
 &#0124;editpage={{{2}}} 
 &#0124;border=#aaaaaa           <nowiki><!-- This is the color of the borders around Box Sections --></nowiki>
 &#0124;titleforeground=white    <nowiki><!-- This is the color of the Box Section Title Bar text --></nowiki>
 &#0124;titlebackground=#aaccff  <nowiki><!-- This is the color of the Box Section Title Bar --></nowiki>
 &#0124;background=#f9f9ff       <nowiki><!-- This is the color of the Box Section background --></nowiki>
 &#0124;foreground=black}}       <nowiki><!-- This is the color of the Box Section text --></nowiki>
|-
!valign="top"| 3.
| Return to your portal page [[Portal:Topic]] and begin editing (general instructions on editing a portal are below). Basically follow the red links to create sub-pages that will fill the boxes.
|-
!valign="top"| 4.
| Place a link to your portal at the top of the appropriate article (of the same name) by placing a {{tl|portal | Topic}} there. If the article has portals already listed or you have created more than one portal for the article, use <nowiki>{{ portal | Topic | portal 2 name| portal 3 name}}</nowiki>.

For an explanation of '''how and why''' this format works go [[Template talk:Box-header|here]].
|-
!valign="top"| 5.
| List your new portal in the [[Wikipedia:Portal/Directory|Directory of portals]].
|-
!valign="top"| 6.
| Announce your new portal on the [[Wikipedia:Community Portal#Community bulletin board|community bulletin board]].
|-
|colspan=2| At this point, you have created a '''''Portal under construction'''''.  It is a framework with a lot of red links where content should go.  A fair amount of work is still necessary to turn a skeleton portal into one ready for browsing.
|-
!valign="top"| 7.
| Edit the portal text.  (See ''[[#Customisation and editing|Customisation and editing]]'' below for instructions.)
|-
!valign="top"| 8.
| When the portal is complete and of good quality:
* Recategorize the portal from [[:Category:Portals under construction]] to an appropriate sub-category of [[:Category:Portals]] (or often a sub-sub-category or deeper, as needed). ''(See [[Wikipedia:Portal/Categorizing]] for details.)''
* Add a link to the portal at [[Portal:Contents/Portals]].
|}

=== Customization and editing ===

The box portal allows you to edit the portal without editing the main portal page. Simply follow the blue links to the sub pages and enter the information there. These sub-pages will be displayed on the main page.

==== Adding a section (box) ====

If you wish to add a section (box) using the regular codes, go to your portal page and simply type in:

<pre>
 {{/box-header| 1 | 2 }}
 {{   3   }}
 {{box-footer| 4 }}
</pre>

where
* '''"1"''' is the box title
* '''"2"''' is the article to be linked to. This will appear right under the title bar. You may omit this parameter if you don't want an edit link to appear, but you must not omit the pipe, for example:
** {{mono|<nowiki>{{/box-header | Selected article | Portal:Computer and video games/Selected}}</nowiki>}}
** {{mono|<nowiki>{{/box-header | Selected article | }}</nowiki>}} ''(no edit link param, note pipe still in place)''
* '''"3"''' is again the article to be linked to (this will appear as a red link until first edited), for example:
** {{mono|<nowiki>{{/Featured}}</nowiki>}}
* '''"4"''' is a link that you'd like to display at the bottom-right corner of the box. You may omit this parameter if you don't want an edit link to appear, but you must not omit the pipe, for example:
** {{mono|<nowiki>{{box-footer | [[Computer and video games|More about Computer and video games...]]}}</nowiki>}}
** {{mono|<nowiki>{{box-footer | }}</nowiki>}} ''(no bottom-right param, note pipe still in place)''
=== Other methods of adding a section ===
Other methods of adding a section are adding [[Template:Random portal component]] or [[Template:Random portal component with nominate]]. see their documentation .

===== Example 1 =====

The following code:

 <nowiki><div style="float:right; width:50%;"></nowiki>
 '''<nowiki>{{/box-header|A random title|Portal:Test/Selected article}}</nowiki>'''
 <nowiki>{{/Selected article}}</nowiki>
 '''<nowiki>{{box-footer|[[Lorem ipsum|More about Lorem ipsum...]]}}</nowiki>'''
 <nowiki></div></nowiki>

results in:

<div style="float:right; width:50%;">
{{Portal:Test/box-header|A random title|Portal:Test/Selected article}}
{{Portal:Test/Selected article}}
{{box-footer|[[Lorem ipsum|More about Lorem ipsum...]]}}
</div>

<br clear=all>

===== Example 2 =====

The following code:

 <nowiki><div style="float:right; width:50%;"></nowiki>
 '''<nowiki>{{/box-header|A random title|}}</nowiki>'''
    <nowiki>The following text will appear in the [[box]]. This text can be placed on 
    the [[Wikipedia:Portal|portals]] main page and edited there. Or, 
    alternately placed on a sub-page of the portal, which is explained below.</nowiki>
 '''<nowiki>{{box-footer|[[Lorem ipsum|More about Lorem ipsum...]]}}</nowiki>'''
 <nowiki></div></nowiki>

<div style="float:right; width:50%;">
{{Portal:Test/box-header|A random title|Wikipedia talk:Wikiportal/box-header}}
The following text will appear in the [[box]]. This text can be placed on the [[Wikipedia:Portal|portals]] main page and edited there. Or, alternately placed on a sub-page of the portal, which is explained below.
{{box-footer|[[Lorem ipsum|More about Lorem ipsum...]]}}
</div>

...will result in what is displayed to the immediate right. '''→'''

The exact same code, used at other portals, will create a box with the exact same content, but the colors may be completely different. This is because each portal has templates at:
# "Portal:''insertname''/box-header" (e.g. [//en.wikipedia.org/w/index.php?title=Portal:Computer_and_video_games/box-header&action=edit])
that add color information, and then pass all the work along to the [[Template:Box-header|box-header]] template, which composes everything into a standards-compliant and cross-browser box.

<div style="clear:both;"></div>

==== Editing Archive for random portal component section ====
For a random portal component section, the random pages are stored as consecutive numbered subpages from 1 to a maximum number. To view all numbered subpages in the archive page, use [[Template:Numbered subpages]]. Just write in the archive page <nowiki>{{Numbered subpages}}</nowiki>.

==== Randomized lists and elements in sections ====
See the [[Template:Random subpage|random subpage template]] for a method to display a list of randomly selected items from a group of numbered subpages (e.g., [[Portal:Sustainable development|Sustainable development]]). This template also can be used to randomly rotate items such as images within a section (e.g., the [[Portal:Philosophy of science/Intro|Philosophy of science introduction]]).

==== Changing colors ====

The colors of the portal can be changed in the box-header subpage. A list of colors you can use is available at [[Web colors]], [[List of colors]], or [[Wikipedia talk:Colours]].

== See also ==
{{Portal template list}}

<includeonly>{{Sandbox other||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:Wikipedia Portal templates]]
[[Category:Wikipedia portal administration|Instructions]]
}}</includeonly>