View source for KRayWiki:Examples

; See Also : [[kraywiki:About|About KRayWiki]]
<br />

=Instructions=

<blockquote>

* Examples are ideally written to allow source copy/paste without opening the editor on this page.
* Recognize that some complex examples may require an edit to see the wiki markup source.
* Reserve this page for:
:* Commonly occurring markup that useful for maintaining consistency across the wiki.
:* Markup that is difficult to create using only the available off-site help.

</blockquote>

=Examples=

<blockquote>

==Back Links and Cross-references==

A basic example:

<div style="background-color: #EEEEEE; border: dashed; border-width: 1px; font-family: courier; margin: 1em 2em; padding: 1ex; white-space: pre;"><nowiki>; See Also : [[Main Page]]<br /></nowiki></div>'''

A more complex example showing several related resources and a more descriptive link:

<div style="background-color: #EEEEEE; border: dashed; border-width: 1px; font-family: courier; margin: 1em 2em; padding: 1ex; white-space: pre;"><nowiki>; See Also : [[CSDI_Wiki:MediaWiki|CSDI MediaWiki Information and Help Index]]
: [[Main Page]]<br /></nowiki></div>'''

; Note :
: It is a best practice to avoid gratuitous linking of pages that appear in either the sidebar or page body.

; Note : Previous recommended placement of <nowiki><br/></nowiki> was below the last line, but now, perhaps due to a software upgrade, it appears that this causes an overlarge vertical gap.  Current recommended placement is appended to the final line (for aesthetics and efficient use of space).

==Category Page Links==

<div style="background-color: #EEEEEE; border: dashed; border-width: 1px; font-family: courier; margin: 1em 2em; padding: 1ex;"><nowiki>
[[Category:Software Resources]]
</nowiki></div>'''

==Font Color==

* Set the <span style="color: purple;">font color</span> inside a styled tag.<br />
<div style="background-color: #EEEEEE; border: dashed; border-width: 1px; font-family: courier; margin: 1em 2em; padding: 1ex;"><nowiki>
<span style="color: purple;">font color</span>
</nowiki></div>'''

==Redirects==

* A redirect allows more than one possible wiki path to reference the same information.  For example, the following redirect could transfer someone from '''CC&nbsp;Office''' to '''Corpus&nbsp;Christi&nbsp;Office''' if it was saved on a page named '''CC&nbsp;Office''' since the term '''CC''' is a convenient shortcut.

<div style="background-color: #EEEEEE; border: dashed; border-width: 1px; font-family: courier; margin: 1em 2em; padding: 1ex;"><nowiki>
#REDIRECT [[Corpus Christi Office]]
</nowiki></div>

==Preformatted Text Box==

* '''''<nowiki><pre></nowiki>''''' tags do not behave as expected when used inside a wiki page.  This work-around behaves more like an HTML tag would work. 
* Adjust ''margin: 1em <strong>2em</strong>''; to set indent level for the box.  The '''''2em''''' corresponds to one : indent.
* Adjust ''margin: <strong>1em</strong> 2em''; sets the vertical spacing around the box.

<div style="background-color: #EEEEEE; border: dashed; border-width: 1px; font-family: courier; margin: 1em 2em; padding: 1ex;"><nowiki>
<div style="background-color: #EEEEEE; border: dashed; border-width: 1px; font-family: courier; margin: 1em 2em; padding: 1ex; white-space: pre;"><nowiki>
</nowiki><br />&lt;/nowiki&gt;&lt;/div&gt;
</div>

</blockquote>

=Site Templates=

<blockquote>

An exhaustive listing of local templates is [[Special:UncategorizedTemplates|here]].

A listing of currently unused templates may be viewed [[Special:UnusedTemplates|here]].

==Page Header Templates==

Place the indicated markup at the top of a page to insert pre-defined page headers.

===Policy===
<div style="background-color: #EEEEEE; border: dashed; border-width: 1px; font-family: courier; margin: 1em 2em; padding: 1ex;"><nowiki>
{{Template:Policy}}
</nowiki></div>
{{Template:Policy}}

===Proprietary===
<div style="background-color: #EEEEEE; border: dashed; border-width: 1px; font-family: courier; margin: 1em 2em; padding: 1ex;"><nowiki>
{{Template:Proprietary}}
</nowiki></div>
{{Template:Proprietary}}

===Restricted===
<div style="background-color: #EEEEEE; border: dashed; border-width: 1px; font-family: courier; margin: 1em 2em; padding: 1ex;"><nowiki>
{{Template:Restricted}}
</nowiki></div>
{{Template:Restricted}}

===WIP===
<div style="background-color: #EEEEEE; border: dashed; border-width: 1px; font-family: courier; margin: 1em 2em; padding: 1ex;"><nowiki>
{{Template:WIP}}
</nowiki></div>

==Server Templates==

Prefer not to refer to server host names, IP address, <nowiki>URLs</nowiki>, etc.  Instead, use a logical names like:

:; <nowiki>{{Template:Server}}</nowiki> :
:: Unadorned logical name template references should expand to a descriptive server name, or host name.

Append a standard suffix to the logical name template to make it easy remember how to reference the server in other ways:

:; <nowiki>{{Template:ServerIP}}</nowiki> :
:: Server IP address
:; <nowiki>{{Template:ServerURL}}</nowiki> :
:: Server web link text (<nowiki>i.e. http://...</nowiki>)
:; <nowiki>{{Template:ServerFileURL}}</nowiki> :
:: Server file share root reference (<nowiki>i.e. file://...</nowiki>)

By following these conventions, it becomes trivial to change all server references everywhere in the wiki at once with a single edit of affected template pages.  When templates are designed well, changes can automatically cascade into related templates without additional edits.  For example, consider that a template may itself refer to another template:

If, for example,

:; <nowiki>{{Template:CompanyInetDomain}}</nowiki> :
::: expands to:
:::: {{Template:CompanyInetDomain}}

Other templates could be written to re-use the base name :

:; <nowiki>{{Template:CompanyWebsiteURL}}</nowiki> :
:: is defined as:
::: {{Template:URLProtocol}}{{Template:CompanyInetDomain}}
:::: expands to:
::::: {{Template:CompanyWebsiteURL}}
:; <nowiki>{{Template:LmnWebsiteURL}}</nowiki> :
:: is defined as:
::: <nowiki>{{Template:CompanyWebsiteURL}}/SDwp/lmn</nowiki>
:::: expands to:
::::: {{Template:LmnWebsiteURL}}
:; <nowiki>{{ManWebsiteURL}}</nowiki> :
:: is defined as:
::: <nowiki>{{CompanyWebsiteURL}}/SDwp/</nowiki>
:::: expands to:
::::: {{Template:ManWebsiteURL}}

In such a set of templates, any change the Domain template trickles down into each subordinate template that references it, whether directly, or indirectly.

</blockquote>

{{Template:WIP}}