Help:Script Samples: Difference between revisions
Content deleted Content added
Caleb Cooper (talk | contribs) |
Caleb Cooper (talk | contribs) Tag: 2017 source edit |
||
| (42 intermediate revisions by 2 users not shown) | |||
Line 1:
<br/>This help page details the extended functionality on the Support Wikis : specifically for text-display and highlighting.<br/><br/>
== Four Main Tags ==
{| class="wikitable"
! Tag !! Code !! Result !! style="width:200px;" | When to use
|-
|
;code
|
To check consumed disk space use <code><code>df -h</code></code> for many linux OS
|
To check consumed disk space use <code>df -h</code> for many linux OS
|
A short excerpt of code inline with a sentence or paragraph of text
|-
|
;pre
|
<pre>
<pre>
WHENEVER A(1).E.FENCE.OR.A(2).E.FENCE.OR.A(3).E.FENCE
PRFULL.($'R'1INSTRUCTIONS:$)
PRFULL.($ '4MAIL NAME1 NAME2 PROB1 PROG1 PROB2 PROG2 ...$)
PRFULL.($ WHERE '=NAME1 NAME2'= IS THE FILE TO BE MAILED,$)
PRFULL.($ AND '=PROBN PROGN'= ARE DIRECTORIES TO WHICH '8$,
1 $IT IS TO BE SENT.'B$)
CHNCOM.(0)
END OF CONDITIONAL
</pre></pre>
|
<pre>
WHENEVER A(1).E.FENCE.OR.A(2).E.FENCE.OR.A(3).E.FENCE
PRFULL.($'R'1INSTRUCTIONS:$)
PRFULL.($ '4MAIL NAME1 NAME2 PROB1 PROG1 PROB2 PROG2 ...$)
PRFULL.($ WHERE '=NAME1 NAME2'= IS THE FILE TO BE MAILED,$)
PRFULL.($ AND '=PROBN PROGN'= ARE DIRECTORIES TO WHICH '8$,
1 $IT IS TO BE SENT.'B$)
CHNCOM.(0)
END OF CONDITIONAL
</pre>
|
Most commonly used when a preformed block of text is required
|-
|
;syntaxhighlight
|
<pre>
<syntaxhighlight lang="bash">
#!/bin/bash
fileCount=800000
b=0
while [ $b -le $fileCount ]
do
echo B = $b
dd if=/dev/urandom of=/mnt/nfs/file$b.txt bs=2k count=1
((b++))
done
</syntaxhighlight>
</pre>
|
<syntaxhighlight lang="bash">
#!/bin/bash
Line 54 ⟶ 70:
done
</syntaxhighlight>
| Used to format code blocks according to the syntax of a language
|-
|
;poem
|
<pre>
<poem>
In [[Wikipedia:Xanadu|Xanadu]] did Kubla Khan
A stately pleasure-dome decree:
Where Alph, the '''sacred river''', ran
Through caverns measureless to man
Down to a sunless sea.
So twice five miles of fertile ground
With walls and towers were girdled round:
And there were gardens bright with sinuous rills,
Where blossomed many an incense-bearing tree;
And here were <span style="color:green">forests</span> ancient as the hills,
Enfolding sunny spots of greenery.
</poem>
</pre>
|
<poem>
In [[Wikipedia:Xanadu|Xanadu]] did Kubla Khan
A stately pleasure-dome decree:
Where Alph, the '''sacred river''', ran
Through caverns measureless to man
Down to a sunless sea.
So twice five miles of fertile ground
With walls and towers were girdled round:
And there were gardens bright with sinuous rills,
Where blossomed many an incense-bearing tree;
And here were <span style="color:green">forests</span> ancient as the hills,
Enfolding sunny spots of greenery.
</poem>
| The poem tags are designed for poetry and prose, though they can be adapted for code listings. Unlike the other 3 they allow the use of wiki markup inside the tags.
|}
== Scrollbars and Text wrapping ==
{| class="wikitable"
! class !! Code !! Result !! When to use
|-
|
default
|
<pre>
<pre>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
</pre>
</pre>
|
<pre>
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
</pre>
|
Default Behavior text is wrapped
|-
|
;scroll
<code>class="scroll"</code>
|
<pre>
<pre class="scroll" style="width:300px;">
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
</pre></pre>
|
<pre class="scroll" style="width:300px;">
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
</pre>
|
Use for text based tables where it is easier to read if the text doesn't wrap
|-
|
;inline
<code>class="inline"</code>
|
<pre>
<syntaxhighlight lang="lisp" class="inline">
(define-behavior (bounce
:start-when (or (bump?)
bounce-trigger? )
:abort-when (bump-edge?)
:onetime? t
)
)
</syntaxhighlight>
</pre>
|
<syntaxhighlight lang="lisp" class="inline">
(define-behavior (bounce
:start-when (or (bump?)
bounce-trigger? )
:abort-when (bump-edge?)
:onetime? t
)
)
</syntaxhighlight>
| Use for smaller text blocks, if it is not desired that pre extend to the full width of the page
|-
|}
== Syntax Highlighting ==
<br><br>
If a programming language is not used the language can be specified as '''text''', also the highlight attribute can be set to highlight lines of code:<br><br>
<code><syntaxhighlight lang="text" highlight="8-11" class="scroll"></code>
<syntaxhighlight lang="text" highlight="8-11" class="scroll">
map profile show where ManagementApp FLUIDFS
<60756 (?)>
Line 78 ⟶ 190:
17 8 8 Cluster FS8600 18 15 18 0 4 0 60757 (0) Fal (0) Fal (3) Both (1) Auto (1) Enab (0) Fal 0 0 0 42949672* Compellent FS8600 1.x FLUIDFS 60757
Walk: Display 4 of 4
</syntaxhighlight
<code></syntaxhighlight></code><br>
<br><br>
----
Demo of color coding using HTML markup and displaying line numbers:
<code><syntaxhighlight lang="html4strict" line class="inline"></code><syntaxhighlight lang="html4strict" line class="inline">
<table align=center style="background: ivory;color:maroon;font-style:italic;font-family:arial;font-weight:bold;font-size:10pt;">
<caption>This is the top caption</caption>
<tr><th> Heading 1 </th><th> Heading 2 </th></tr>
<tr>
<td style="padding:10px;"> This is cell 1 text </td>
<td style="padding:10px;"> This is cell 2 text </td>
</tr>
</table>
</syntaxhighlight><code></syntaxhighlight></code><br>
<br><br>
Line 121 ⟶ 225:
<code></syntaxhighlight></code>
<br/><br/>
== Changing Colours ==
{| class="wikitable"
! class !! Code !! Result !! style="width:200px;" | When to use
|-
|
;blue-white
<code>class=blue-white</code>
|
<pre>
<pre class="blue-white">
buffer = OPENSSL_malloc(1 + 2 + payload + padding);
bp = buffer;
/* Enter response type, length and copy payload */
*bp++ = TLS1_HB_RESPONSE;
s2n(payload, bp);
memcpy(bp, pl, payload);
bp += payload;
/* Random padding */
RAND_pseudo_bytes(bp, padding);
</pre></pre>
</pre>
|
<pre class="blue-white">
buffer = OPENSSL_malloc(1 + 2 + payload + padding);
bp = buffer;
/* Enter response type, length and copy payload */
*bp++ = TLS1_HB_RESPONSE;
s2n(payload, bp);
memcpy(bp, pl, payload);
bp += payload;
/* Random padding */
RAND_pseudo_bytes(bp, padding);
</pre>
|
White on a Blue background
|-
|
;black-white
<code>class=black-white</code>
|
<pre>
<syntaxhighlight lang="javascript" highlight="13" class="black-white">
JSFX.FireSpark.prototype.changeColour = function()
{
var colour="";
r2= Math.random()*255;
g2= r2;
b2= 0;
if(!(r2 | g2 | b2))
{
r2=255;
g2=255;
b2=0;
}
colour = "#" + dec2hex(r2) + dec2hex(g2) + dec2hex(b2);
this.setBgColor(colour);
}
</syntaxhighlight>
</pre>
|
<div style="width:400px;">
<syntaxhighlight lang="javascript" highlight="13" class="black-white">
JSFX.FireSpark.prototype.changeColour = function()
{
var colour="";
r2= Math.random()*255;
g2= r2;
b2= 0;
if(!(r2 | g2 | b2))
{
r2=255;
g2=255;
b2=0;
}
colour = "#" + dec2hex(r2) + dec2hex(g2) + dec2hex(b2);
this.setBgColor(colour);
}
</syntaxhighlight></div>
|
White on a black background
|-
|
;black-green
<code>class=black-green</code>
|
<pre>
<syntaxhighlight lang="text" highlight="9" class="black-green scroll">
TEXT BASED TABLE OUTPUT HERE
</syntaxhighlight>
</pre>
|
<div style="width:400px;">
<syntaxhighlight lang="text" highlight="9" class="black-green scroll">
map profile show where ManagementApp FLUIDFS
<60756 (?)>
[60756] Mapping:MappingProfile 02/15/2013 12:53:34 AM
Index Server Server Volume MZ MZ MultiPat LUN Persona Personali Boot Write VM Managemen Admin DebugOu Active Bad Path LUN OS OS ManagementApp Active
Name Subsyst VolumeI Max Actual Preferr Actual Volume Protect Connect Status PathCo PathCo DownCo OnlyOne Product Version Controller
======= ======== =================================== ======= ======= ======= ======== ====== ======= ========= ======= ======= ========= ========= ======== ======= ====== ====== ====== ========= ============ ============ ============================== ==========
14 8 8 Cluster FS8600 15 15 15 0 1 0 60756 (0) Fal (0) Fal (3) Both (1) Auto (1) Enab (0) Fal 0 0 0 42949672* Compellent FS8600 1.x FLUIDFS 60756
15 8 8 Cluster FS8600 16 15 16 0 2 0 60757 (0) Fal (0) Fal (3) Both (1) Auto (1) Enab (0) Fal 0 0 0 42949672* Compellent FS8600 1.x FLUIDFS 60757
16 8 8 Cluster FS8600 17 15 17 0 3 0 60756 (0) Fal (0) Fal (3) Both (1) Auto (1) Enab (0) Fal 0 0 0 42949672* Compellent FS8600 1.x FLUIDFS 60756
17 8 8 Cluster FS8600 18 15 18 0 4 0 60757 (0) Fal (0) Fal (3) Both (1) Auto (1) Enab (0) Fal 0 0 0 42949672* Compellent FS8600 1.x FLUIDFS 60757
Walk: Display 4 of 4
</syntaxhighlight></div>
| Green on a Black background
|-
|}
== Indenting <code><pre></code> tags ==
{{Caution|The only reliable way to get indents with <code><pre></code> tags is to use: <code>{{indent{{!}}<pre> code here <p/pre>}}</code>; <br /> For <code><code></code> and <code><syntaxhighlight></code> tags a <code>:</code> works fine}}
<pre>
{{Indent|{{Pre|class=blue-white|# for i in $(diskview -I s {{!}} awk '/Online/{print $2}'); do echo -e "\n::: ${i} :::"; dd if{{eq}}/dev/rpd${i}d bs{{eq}}512 count{{eq}}1 of{{eq}}/pss/cc/o-dsb-${i}.bin; done}}}}
</pre>
{{Indent|{{Pre|class=blue-white|# for i in $(diskview -I s {{!}} awk '/Online/{print $2}'); do echo -e "\n::: ${i} :::"; dd if{{eq}}/dev/rpd${i}d bs{{eq}}512 count{{eq}}1 of{{eq}}/pss/cc/o-dsb-${i}.bin; done}}}}
{{Note|There is something intermittent about the method below working which I haven't figured out yet. It doesn't render correctly below but it does on other pages
[[File:Pre in a numbered list.png]]
}}
{| class="wikitable"
| {{rh}} | Code
Line 136 ⟶ 377:
|
# one
#
#::some stuff
#::some more stuff
</pre>
# two
|}
{{Tip|Because syntaxhighlight wraps everything in a <code><div></code> it works to indent with <code>;</code> and <code>:</code> as below}}
<pre>
; Something to notice in bash example below
:<syntaxhighlight lang=bash inline>
#!/bin/bash fileCount=800000 b=0 while [ $b -le $fileCount ] do echo B = $b dd if=/dev/urandom of=/mnt/nfs/file$b.txt bs=2k count=1 ((b++)) done
</syntaxhighlight>
</pre>
; Something to notice in bash example below
:<syntaxhighlight lang=bash inline>
#!/bin/bash
fileCount=800000
b=0
while [ $b -le $fileCount ]
do
echo B = $b
dd if=/dev/urandom of=/mnt/nfs/file$b.txt bs=2k count=1
((b++))
done
</syntaxhighlight>
; Something to notice in bash example below
:<syntaxhighlight lang=bash>
#!/bin/bash
fileCount=800000
b=0
while [ $b -le $fileCount ]
do
echo B = $b
dd if=/dev/urandom of=/mnt/nfs/file$b.txt bs=2k count=1
((b++))
done
</syntaxhighlight>
<pre>
;Same works for code tags:
:<code>Indented code snippet</code>
</pre>
;Same works for code tags:
:<code>Indented code snippet</code>
== Annotate <code><pre></code> contents with Pointers / Boxes ==
Line 233 ⟶ 515:
{{Caution|Note that <code>{{eq}}</code> and <code>{{!}}</code> always have to be escaped in templates, the templates <code>{{!}}</code> and <code>{{eq}}</code> have been provided for this purpose, example below requiring this. Also it is not possible to use <code>:</code> for indents, use <code>{{Indent}}</code> template instead
<br>
=== Highlighting ===
{| class="wikitable"
! class !! Code !! Result !! style="width:200px;" | Colour
|-
|
NA
|
<pre>
<syntaxhighlight lang=text highlight="2" inline">
line one
line two
line three
line four
</syntaxhighlight>
</pre>
|
<syntaxhighlight lang=text highlight="2" inline">
line one
line two
line three
line four
</syntaxhighlight>
|
Mediawiki Default Yellow Highlight
|-
|
;orange-highlight
<code>class="orange-highlight"</code>
|
<pre>
<syntaxhighlight lang=text highlight="3" class="orange-highlight inline">
line one
line two
line three
line four
</syntaxhighlight>
</pre>
|
<syntaxhighlight lang=text highlight="3" class="orange-highlight inline">
line one
line two
line three
line four
</syntaxhighlight>
|
Fluorescent Orange
|-
|
;green-highlight
<code>class="green-highlight"</code>
|
<pre>
<syntaxhighlight lang=text highlight="1" class="green-highlight inline">
line one
line two
line three
line four
</syntaxhighlight>
</pre>
|
<syntaxhighlight lang=text highlight="1" class="green-highlight inline">
line one
line two
line three
line four
</syntaxhighlight>
| Fluorescent Green
|-
|
;pink-highlight
<code>class="pink-highlight"</code>
|
<pre>
<syntaxhighlight lang=text highlight="4" class="pink-highlight inline">
line one
line two
line three
line four
</syntaxhighlight>
</pre>
|
<syntaxhighlight lang=text highlight="4" class="pink-highlight inline">
line one
line two
line three
line four
</syntaxhighlight>
| Fluorescent Pink
|-
|
;blue-highlight
<code>class="blue-highlight"</code>
|
<pre>
<syntaxhighlight lang=text highlight="3" class="blue-highlight inline">
line one
line two
line three
line four
</syntaxhighlight>
</pre>
|
<syntaxhighlight lang=text highlight="3" class="blue-highlight inline">
line one
line two
line three
line four
</syntaxhighlight>
| Fluorescent Blue
|-
|}
| |||