Policy 1707 commit to LF
[policy/engine.git] / POLICY-SDK-APP / src / main / webapp / app / policyApp / CSS / bootstrap / docs / _includes / css / code.html
1 <div class="bs-docs-section">
2   <h1 id="code" class="page-header">Code</h1>
3
4   <h2 id="code-inline">Inline</h2>
5   <p>Wrap inline snippets of code with <code>&lt;code&gt;</code>.</p>
6 <div class="bs-example" data-example-id="inline-code">
7   For example, <code>&lt;section&gt;</code> should be wrapped as inline.
8 </div>
9 {% highlight html %}
10 For example, <code>&lt;section&gt;</code> should be wrapped as inline.
11 {% endhighlight %}
12
13   <h2 id="code-user-input">User input</h2>
14   <p>Use the <code>&lt;kbd&gt;</code> to indicate input that is typically entered via keyboard.</p>
15 <div class="bs-example" data-example-id="simple-kbd">
16   To switch directories, type <kbd>cd</kbd> followed by the name of the directory.<br>
17   To edit settings, press <kbd><kbd>ctrl</kbd> + <kbd>,</kbd></kbd>
18 </div>
19 {% highlight html %}
20 To switch directories, type <kbd>cd</kbd> followed by the name of the directory.<br>
21 To edit settings, press <kbd><kbd>ctrl</kbd> + <kbd>,</kbd></kbd>
22 {% endhighlight %}
23
24   <h2 id="code-block">Basic block</h2>
25   <p>Use <code>&lt;pre&gt;</code> for multiple lines of code. Be sure to escape any angle brackets in the code for proper rendering.</p>
26 <div class="bs-example" data-example-id="simple-pre">
27   <pre>&lt;p&gt;Sample text here...&lt;/p&gt;</pre>
28 </div>
29 {% highlight html %}
30 <pre>&lt;p&gt;Sample text here...&lt;/p&gt;</pre>
31 {% endhighlight %}
32
33   <p>You may optionally add the <code>.pre-scrollable</code> class, which will set a max-height of 350px and provide a y-axis scrollbar.</p>
34   <h2 id="code-variables">Variables</h2>
35   <p>For indicating variables use the <code>&lt;var&gt;</code> tag.</p>
36   <div class="bs-example" data-example-id="simple-var">
37     <p><var>y</var> = <var>m</var><var>x</var> + <var>b</var></p>
38
39   </div>
40 {% highlight html %}
41 <var>y</var> = <var>m</var><var>x</var> + <var>b</var>
42 {% endhighlight %}
43
44   <h2 id="code-sample-output">Sample output</h2>
45   <p>For indicating blocks sample output from a program use the <code>&lt;samp&gt;</code> tag.</p>
46   <div class="bs-example" data-example-id="simple-samp">
47     <p><samp>This text is meant to be treated as sample output from a computer program.</samp></p>
48   </div>
49 {% highlight html %}
50 <samp>This text is meant to be treated as sample output from a computer program.</samp>
51 {% endhighlight %}
52 </div>