Short Code

Short Code allows administrators to create reusable dynamic content blocks and execute them inside pages, layers, banners, product details, board content, and other iBoard-managed areas.

Use Short Code when the same content or logic needs to be reused in multiple places without copying the same HTML or code repeatedly.

Overview

A shortcode is a named reusable block. After creating a shortcode, you can call it from a page using a bracket syntax. Parameters can be passed into the shortcode and used as replaceable variables inside the shortcode content.

Shortcode List

The Shortcode List page displays existing shortcodes. Administrators can search, review, edit, or delete shortcode records.

Main Elements

Shortcode Editor

The Shortcode Editor is used to create or update a shortcode. It includes the shortcode type, name, shortcode content editor, usage guide, examples, and AI / CodeDom guidance.

Editor Fields

Basic Syntax

A shortcode is called with square brackets. The shortcode name is followed by parameters.

[Execute_Test id=1 row=5 layer=radix_boxton]

In this example, Execute_Test is the shortcode name, and id, row, and layer are parameters.

Create a Shortcode

1. Open Admin > Site > Short Code.
2. Click New Shortcode.
3. Select the shortcode type.
4. Enter the shortcode name.
5. Write the shortcode content in the editor.
6. Click Add & Update.

Name Example

Execute_Test

The shortcode name must match the name used inside the page or content area.

Call the Shortcode

After saving a shortcode, call it inside a page, layer, banner, product detail, or board content.

[Execute_Test id=1 row=5 layer=radix_boxton]

Parameters

Parameters are values passed into the shortcode call. Inside the shortcode content, each parameter becomes a replaceable variable. Add # before the parameter name to use it.

Important Parameter Rule

Parameters must be separated by spaces.

Correct:
[Execute_Test id=1 row=5 layer=radix_boxton]

Wrong:
[Execute_Test id=1,row=5,layer=radix_boxton]

Do not separate parameters with commas. Use spaces between parameters.

Usage Guide Tab

The Usage Guide tab explains the standard process for creating and calling shortcodes. It includes the basic syntax, parameter usage, and important formatting rules.

Examples Tab

The Examples tab provides reusable shortcode examples. These examples can be copied and modified to fit your page or project.

Example 1 - Basic Output

[Execute_Test id=1 row=5 layer=radix_boxton]

ShortCode content:

<div>
    ID: #id<br />
    Layer: #layer
</div>

Example 2 - CodeDom Loop

This example uses the row parameter to generate repeated output.

[Execute_Test row=5 layer=radix_boxton]

ShortCode content:

<codedom>

    using System;
    using System.Text;

    StringBuilder sb = new StringBuilder();

    for (int i = 0; i < #row; i++)
    {
        sb.AppendLine(string.Format("No.{0} / Layer: {1}<br />", i, "#layer"));
    }

    return sb.ToString();

</codedom>

Example 3 - Bootstrap Card

[Execute_Card title="Camera Finder" desc="Find the right industrial camera."]

ShortCode content:

<div class="card">
    <div class="card-body">
        <h5 class="card-title">#title</h5>
        <p class="card-text">#desc</p>
    </div>
</div>

AI & CodeDom

The AI & CodeDom tab provides a recommended prompt that can be used to generate C# CodeDom shortcode code. The generated code can be copied into the Short Code editor.

Recommended AI Prompt

Create C# CodeDom code for iBoard Shortcode Editor.

Requirements:
- Use <codedom> wrapper.
- Use StringBuilder.
- Return string.
- Receive #row parameter.
- Receive #layer parameter.
- Generate HTML output.
- Do not create controller code.
- Do not create Razor view code.
- Only generate the CodeDom block.

AI Generated CodeDom Example

<codedom>

    using System;
    using System.Text;

    StringBuilder sb = new StringBuilder();

    sb.AppendLine("<div class='shortcode-result'>");

    for (int i = 0; i < #row; i++)
    {
        sb.AppendLine(string.Format("<div>Row {0} / Layer: {1}</div>", i, "#layer"));
    }

    sb.AppendLine("</div>");

    return sb.ToString();

</codedom>

Recommended Workflow

1. Decide where the shortcode will be used.
2. Create a clear shortcode name.
3. Define the parameters that the shortcode needs.
4. Create the shortcode content in the editor.
5. Save the shortcode.
6. Call the shortcode from a page or content area.
7. Preview and confirm the output.

Common Use Cases

Important Notes

• The shortcode name must match the name used in the page.
• Parameters must be separated by spaces.
• Use #parameterName to reference parameter values inside shortcode content.
• Test shortcode output before using it on a live page.
• Be careful when using CodeDom because it executes dynamic C# code.
• Only trusted administrators should be allowed to create or edit executable shortcodes.

Troubleshooting

Best Practices

• Use descriptive shortcode names.
• Keep shortcode parameters simple and predictable.
• Use lowercase parameter names when possible.
• Avoid placing sensitive logic in public-facing shortcodes.
• Document each shortcode purpose and expected parameters.
• Test CodeDom shortcodes in a safe environment before using them in production.

Shortcodes are powerful because they can reuse content and dynamic logic across multiple pages. Keep them organized and test them carefully before publishing.