Difference between revisions of "Syntax Example"

From WHMCS Documentation

(→‎Multi-line Code Block)
(→‎Headers)
 
(3 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
 
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.
 
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.
 +
 +
==Names in the Product==
 +
 +
To do this, go to '''Section > Section > Interface Name'''
 +
and choose ''Menu Item'' from the '''Name Of Menu''' menu. Then, click '''Save'''.
 +
 +
<source lang="php">
 +
To do this, go to '''Section > Section > Interface Name'''
 +
and choose ''Menu Item'' from the '''Name Of Menu''' menu. Then, click '''Save'''.
 +
</source>
  
 
==Icons==
 
==Icons==
Line 12: Line 22:
  
 
See https://fortawesome.github.io/Font-Awesome/icons/ for a full list of possible icon values.
 
See https://fortawesome.github.io/Font-Awesome/icons/ for a full list of possible icon values.
 +
 +
==Linking==
 +
 +
For more information about domain spotlights, see [[Domain_Pricing_Matrix|Domain Pricing Matrix page]].
 +
 +
For more information about domain spotlights, see [[Domain Pricing Matrix]].
 +
 +
<source lang="php">
 +
For more information about domain spotlights, see [[Domain_Pricing_Matrix|Domain Pricing Matrix page]].
 +
For more information about domain spotlights, see [[Domain Pricing Matrix]].
 +
</source>
 +
 +
===Anchors===
 +
 +
'''Adding the anchor'''
 +
 +
(This has no visual impact on the page.)
 +
 +
<source lang="php">
 +
===== <span id="ex-config"></span>Example installation with configuration data =====
 +
</source>
 +
 +
'''Linking to Anchors from a Different Page'''
 +
 +
[[Page_Title#Anchor|see Anchor in Page Title]]
 +
 +
<source lang="php">
 +
[[Page_Title#Anchor|see Anchor in Page Title]]
 +
</source>
 +
 +
'''Linking to Anchors from the Same Page'''
 +
 +
[[#Anchor|see Anchor below]]
 +
 +
<source lang="php">
 +
[[#Anchor|see Anchor below]]
 +
</source>
 +
 +
==Headers==
 +
All headers, with the exception of FAQ headers, need to use title case rather than sentence case.
 +
<source lang="php">
 +
==Parent Section==
 +
Main section text that applies to all the below items goes here.
 +
 +
===Subtopic 1===
 +
Content that has to do with a specific aspect of or item in the larger section.
 +
 +
===Subtopic 2===
 +
Content that has to do with a specific aspect of or item in the larger section.
 +
 +
====Detail of subtopic A====
 +
 +
Content about a sub-aspect of this aspect of the parent section.
 +
 +
====Detail of subtopic B====
 +
 +
Content about a sub-aspect of this aspect of the parent section.
 +
</source>
  
 
==Pre-formatted Text==
 
==Pre-formatted Text==
 +
 +
'''Inline with text'''
 +
 +
<tt>/modules/servers/ahsaybackups/</tt>
 +
 +
<source lang="php">
 +
<tt>/modules/servers/ahsaybackups/</tt>
 +
</source>
 +
 +
'''In a code block'''
  
 
<div class="source-cli">
 
<div class="source-cli">
Line 25: Line 103:
 
</source>
 
</source>
  
−
==Multi-line Code Block==
+
'''Multi-line Code Block'''
  
 
<div class="source-cli">
 
<div class="source-cli">
Line 43: Line 121:
 
<br/>Line
 
<br/>Line
 
</div>
 
</div>
−
</source>
 
−
 
−
==PHP Source Code==
 
−
 
−
<source lang="php">
 
−
<?php
 
−
$license = 'WHMCS-123456789';
 
−
$db_host = 'localhost';
 
−
$db_username = 'a_user';
 
−
$db_password = 'a_password';
 
−
$db_name = 'whmcs';
 
−
$cc_encryption_hash = 'abCU55KUy40y38PWPfyXLPDQXG3P7TkcJhWEdwoCqf0keG7TLvHmaa2XHWCFGXXx';
 
−
$templates_compiledir = 'templates_c/';
 
−
$mysql_charset = 'utf8';
 
 
</source>
 
</source>
  
Line 119: Line 183:
 
==Tables==
 
==Tables==
  
−
'''**Below is the Preferred Method**'''
+
'''General Tables'''
 +
 
 
<table class="table table-striped table-condensed">
 
<table class="table table-striped table-condensed">
 
<tr><th>Column Name</th><th>Column Name</th></tr>
 
<tr><th>Column Name</th><th>Column Name</th></tr>
Line 136: Line 201:
 
</source>
 
</source>
  
−
<table class="table table-striped">
+
'''On Module Pages'''
−
<tr>
 
−
<td>'''Field Title'''</td>
 
−
<td>'''Another Field'''</td>
 
−
</tr>
 
−
<tr>
 
−
<td>Row 1</td>
 
−
<td>Some value</td>
 
−
</tr>
 
−
<tr>
 
−
<td>Row 2</td>
 
−
<td>Another value</td>
 
−
</tr>
 
−
</table>
 
−
 
 
−
<source lang="php">
 
−
<table class="table table-striped">
 
−
<tr>
 
−
<td>'''Field Title'''</td>
 
−
<td>'''Another Field'''</td>
 
−
</tr>
 
−
<tr>
 
−
<td>Row 1</td>
 
−
<td>Some value</td>
 
−
</tr>
 
−
<tr>
 
−
<td>Row 2</td>
 
−
<td>Another value</td>
 
−
</tr>
 
−
</table>
 
−
</source>
 
  
−
<table class="table table-bordered">
+
{{registrar
−
<tr>
+
| register = yes
−
<td>'''Field Title'''</td>
+
| transfer = yes
−
<td>'''Another Field'''</td>
+
| renew = yes
−
</tr>
+
| dns = yes
−
<tr>
+
| whois = yes
−
<td>Row 1</td>
+
| getepp = yes
−
<td>Some value</td>
+
| regns = yes
−
</tr>
+
}}
−
<tr>
 
−
<td>Row 2</td>
 
−
<td>Another value</td>
 
−
</tr>
 
−
</table>
 
  
 
<source lang="php">
 
<source lang="php">
−
<table class="table table-bordered">
+
{{registrar
−
<tr>
+
| register = yes
−
<td>'''Field Title'''</td>
+
| transfer = yes
−
<td>'''Another Field'''</td>
+
| renew = yes
−
</tr>
+
| dns = yes
−
<tr>
+
| whois = yes
−
<td>Row 1</td>
+
| getepp = yes
−
<td>Some value</td>
+
| regns = yes
−
</tr>
+
}}
−
<tr>
 
−
<td>Row 2</td>
 
−
<td>Another value</td>
 
−
</tr>
 
−
</table>
 
 
</source>
 
</source>
  
Line 253: Line 278:
  
 
==Lists==
 
==Lists==
 +
 +
'''Bulleted List'''
  
 
* This is a list
 
* This is a list
Line 259: Line 286:
 
* This is a list
 
* This is a list
 
* This is a list
 
* This is a list
 +
 +
<source lang="php">
 +
* This is a list
 +
** This is a list
 +
** This is a list
 +
* This is a list
 +
* This is a list
 +
</source>
 +
 +
'''Numbered List'''
  
 
#This is a numbered list
 
#This is a numbered list
Line 265: Line 302:
 
##This is a numbered list
 
##This is a numbered list
 
##This is a numbered list
 
##This is a numbered list
 +
 +
<source lang="php">
 +
#This is a numbered list
 +
#This is a numbered list
 +
##This is a numbered list
 +
##This is a numbered list
 +
##This is a numbered list
 +
</source>
 +
 +
'''Mixed List'''
 +
 +
These are steps with bullets:
 +
#These are steps and bullets
 +
#These are steps and bullets
 +
#*These are steps and bullets
 +
#*These are steps and bullets
 +
#These are steps and bullets
 +
 +
These are bullets with steps:
 +
*These are steps and bullets
 +
*These are steps and bullets
 +
*#These are steps and bullets
 +
*#These are steps and bullets
 +
*These are steps and bullets
 +
 +
<source lang="php">
 +
These are steps with bullets:
 +
#These are steps and bullets
 +
#These are steps and bullets
 +
#*These are steps and bullets
 +
#*These are steps and bullets
 +
#These are steps and bullets
 +
 +
These are bullets with steps:
 +
*These are steps and bullets
 +
*These are steps and bullets
 +
*#These are steps and bullets
 +
*#These are steps and bullets
 +
*These are steps and bullets
 +
</source>

Latest revision as of 13:22, 31 July 2020

Text

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.

Names in the Product

To do this, go to Section > Section > Interface Name and choose Menu Item from the Name Of Menu menu. Then, click Save. 

To do this, go to '''Section > Section > Interface Name'''
and choose ''Menu Item'' from the '''Name Of Menu''' menu. Then, click '''Save'''.

Icons

<i class="fa fa-wrench"></i> <i class="fa fa-gear"></i> <i class="fa fa-cube"></i>

See https://fortawesome.github.io/Font-Awesome/icons/ for a full list of possible icon values.

Linking

For more information about domain spotlights, see Domain Pricing Matrix page.

For more information about domain spotlights, see Domain Pricing Matrix. 

For more information about domain spotlights, see [[Domain_Pricing_Matrix|Domain Pricing Matrix page]].
For more information about domain spotlights, see [[Domain Pricing Matrix]].

Anchors

Adding the anchor

(This has no visual impact on the page.) 

===== <span id="ex-config"></span>Example installation with configuration data =====

Linking to Anchors from a Different Page

see Anchor in Page Title 

[[Page_Title#Anchor|see Anchor in Page Title]]

Linking to Anchors from the Same Page

see Anchor below 

[[#Anchor|see Anchor below]]

Headers

All headers, with the exception of FAQ headers, need to use title case rather than sentence case. 

==Parent Section==
Main section text that applies to all the below items goes here.
 
===Subtopic 1===
Content that has to do with a specific aspect of or item in the larger section.
 
===Subtopic 2===
Content that has to do with a specific aspect of or item in the larger section.
 
====Detail of subtopic A====
 
Content about a sub-aspect of this aspect of the parent section.
 
====Detail of subtopic B====
 
Content about a sub-aspect of this aspect of the parent section.

Pre-formatted Text

Inline with text

/modules/servers/ahsaybackups/ 

<tt>/modules/servers/ahsaybackups/</tt>

In a code block

Some preformatted text 

<div class="source-cli">
Some preformatted text
</div>

Multi-line Code Block

Line
Line
Line
Line
Line 

<div class="source-cli">
<br/>Line
<br/>Line
<br/>Line
<br/>Line
<br/>Line
</div>

Standout Text

Text inside here will be centered. Use this to include links to related pages.
<div class="docs-related-pages">Text inside here will be centered. Use this to include links to related pages.</div>

Alerts

xyz
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 

<div class="docs-alert-success">
<span class="title">xyz</span><br />
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
</div>

xyz
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 

<div class="docs-alert-info">
<span class="title">xyz</span><br />
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
</div>

xyz
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 

<div class="docs-alert-warning">
<span class="title">xyz</span><br />
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
</div>

xyz
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. 

<div class="docs-alert-danger">
<span class="title">xyz</span><br />
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
</div>

Tables

General Tables

Column NameColumn Name
Value$2.00
Value$1.00
Value$0.50
<table class="table table-striped table-condensed">
<tr><th>Starting Quantity</th><th>Price per Database</th></tr>
<tr><td>0</td><td>$2.00</td></tr>
<tr><td>10</td><td>$1.00</td></tr>
<tr><td>20</td><td>$0.50</td></tr>
</table>

On Module Pages


Supported Features

Register Transfer Renew Registrar Lock
Yes Yes Yes No
Update Nameservers Update WHOIS Get EPP Code Register Nameservers
Yes Yes Yes Yes
DNS Record Management Email Forwarding Domain Release Domain Sync Script
No No No No
Premium Domains Transfer Out Automation TLD Pricing Sync
No No No 
{{registrar
| register = yes
| transfer = yes
| renew = yes
| dns = yes
| whois = yes
| getepp = yes
| regns = yes
}}

Columns

2 Columns

Column 1 text goes here...

Column 2 text goes here... 

<div class="row">
<div class="col-sm-6">
Column 1 text goes here...
</div>
<div class="col-sm-6">
Column 2 text goes here...
</div>
</div>

3 Columns

Column 1 text goes here...

Column 2 text goes here...

Column 3 text goes here... 

<div class="row">
<div class="col-sm-4">
Column 1 text goes here...
</div>
<div class="col-sm-4">
Column 2 text goes here...
</div>
<div class="col-sm-4">
Column 3 text goes here...
</div>
</div>

Lists

Bulleted List

  • This is a list
    • This is a list
    • This is a list
  • This is a list
  • This is a list
* This is a list
** This is a list
** This is a list
* This is a list
* This is a list

Numbered List

  1. This is a numbered list
  2. This is a numbered list
    1. This is a numbered list
    2. This is a numbered list
    3. This is a numbered list
#This is a numbered list
#This is a numbered list
##This is a numbered list
##This is a numbered list
##This is a numbered list

Mixed List

These are steps with bullets:

  1. These are steps and bullets
  2. These are steps and bullets
    • These are steps and bullets
    • These are steps and bullets
  3. These are steps and bullets

These are bullets with steps:

  • These are steps and bullets
  • These are steps and bullets
    1. These are steps and bullets
    2. These are steps and bullets
  • These are steps and bullets
These are steps with bullets:
#These are steps and bullets
#These are steps and bullets
#*These are steps and bullets
#*These are steps and bullets
#These are steps and bullets
 
These are bullets with steps:
*These are steps and bullets
*These are steps and bullets
*#These are steps and bullets
*#These are steps and bullets
*These are steps and bullets
Retrieved from "http://3.17.75.209/index.php?title=Syntax_Example&oldid=28729"