...Processing...
error
big error
Using short codes at TutnIQ - TutnIQ
Table of contents X

Using short codes at TutnIQ

Learn how to enhance your tutorials with shortcodes.

  • Shortcodes are shortcuts which allow advanced users to do useful things in their tutorials, FAQs or glossaries, which would not otherwise be possible using TutnIQ. TutnIQ shortcodes work in tutorial text blocks, FAQ answers and glossary definitions.

  • Introduction: Shortcodes at TutnIQ

    In this section we will learn about shortcode syntax, the different shortcodes available at TutnIQ, and the limitations of shortcodes.

  • Shortcodes are shortcuts or commands, which we can use to add features to our tutorials, FAQs and glossaries.

    TutnIQ offers a number of different shortcodes which can be used to do different things, for example:

    ShortcodeDescription
    [note]Create an information box
    [spoiler]Hide the answer from the user
    [jump]Create an url to a specific section of a tutorial
    [table]Create a table (like this one)
    [spreadsheet]Create a table which looks like a spreadsheet
    [finance]Create a plain table (ideal for financial statements)

    We will be adding more, so watch the blog for announcements!

    Syntax

    At TutnIQ most shortcodes require an opening and closing tag: [shortcode]<-This is the opening shortcode tag and this is the closing shortcode tag ->[/shortcode] (notice that the closing tag has a forward slash /).

    Some shortcodes can be self-terminating: [shortcode /], but this is rare at TutnIQ.

    TutnIQ does not currently use standalone shortcodes: [shortcode] (no terminating tag).

    Some shortcodes can be given attributes which modify the way the shortcode operates, for example: [shortcode attribute1="blah" attribute2="etc"]Content[/shortcode]. Specific attributes are discussed in the section dealing with the individual shortcodes.

    Rules / limitations of shortcodes

    • Shortcodes must be enclosed with [square brackets].

    • Shortcodes cannot be self nested. Self nested tags confuse the shortcode parser which will result in the shortcode not working correctly. Example of self nested shortcode:

      [shortcode]
        The next shortcode tag is identical to the preceding shortcode tag 
        [shortcode]
            This will NOT work properly
        [/shortcode]
       [/shortcode]
      
    • Do not forget the forward slash (/) in the closing tag! Example: [/closingtag].

    Note: Please be very careful when using shortcodes - they are a powerful feature - incorrect use may result in a mangled page! You won't lose any data, but it will not look pretty! Tip: Use the preview function in the course builder to make sure that your tutorial / FAQ / glossary displays correctly.

    We may disable shortcodes for users who do not use them correctly.

[Section: 1 of 4]
ad placeholder

Sharing is caring!

About the author

Course stats

My progress

Find related courses