Extensions

OpenForum Extended Markup

ActionButton

A button that fires an OpenForum GET action

Parameters

action = Action Name
text = Action button text
parameters = Optional parameters to pass to the action

[{ActionButton action="Rebuild" parameters="pageName=Home" text="Rebuild Wiki"}]

ActionInput

An input field that fires an OpenForum GET action

Parameters

action = Action Name
parameters = Optional parameters to pass to the action

[{ActionInput action="alert" parameters="pageName=Home"}]

AttachmentsList

Lists attachments for a page with optional filtering

Parameters

targetPage = Page name to list attachments from (blank for current page)
matching = Filter pattern (e.g., ".txt" for text files)

[{AttachmentsList targetPage="" matching=".txt"}]

Banner

Creates a banner with image, title, and text

Parameters

imageURL = URL of the banner image
title = Banner title
text = Banner text content

[{Banner imageURL="/path/to/image.jpg" title="Welcome" text="Welcome to our site"}]

Bookmarklet

Adds a link to automatically bookmark a page

Parameters

title = Bookmark title Name
domain = external site domain
script = Path to script

[{Bookmarklet title="Bookmark" domain="https://open-forum.onestonesoup.org" script="/OpenForum/Extensions/Bookmarklet/append-link.js" text="Bookmark pages more easily. Drag this bookmarklet to the Bookmarks bar of your browser:"}]

Button

Deprecated - Use /OpenForum/Extensions/ActionButton instead

Parameters

title = Button text
function = JavaScript function to call

[{Button title="Do Action" function="doAction"}]

CTABanner

Creates a call-to-action banner with image, title, text, and button

Parameters

imageURL = URL of the banner image
title = Banner title
text = Description text for the CTA
ctaText = Text for the call-to-action button
ctaURL = URL the button links to

[{CTABanner imageURL="/OpenForum/Images/open-forum-dog-small.png" title="Call To Action" text="A description of the CTA" ctaText="Click Me" ctaURL="http://www.bbc.co.uk"}]

ChildPagesList

Creates a bulleted list of child pages

Parameters

pageName = The page to list children of (optional, default = current page)

[{ChildPagesList pageName="/OpenForum"}]

ChildrenContentsPage

Creates a content page showing the contents section from each child page

Parameters

pageName = The page to list children of (optional, default = current page)

[{ChildrenContentsPage pageName="/OpenForum"}]

Clock

Displays a live clock

Parameters

None

[{Clock}]

ContrastBlock

Creates a colored block with text and optional image

Parameters

text = Text content for the block
backgroundColor = Background color (e.g., "blueviolet")
textColor = Text color (e.g., "white")
imageURL = URL of image to display
imageRight = Position image on right side ("true" or "false")

[{ContrastBlock text="Some text in here" backgroundColor="blueviolet" textColor="white" imageURL="/OpenForum/Images/open-forum-dog.png" imageRight="false"}]

CountDown

Creates a countdown timer that triggers an action

Parameters

counter = Name/label for the counter
action = JavaScript action to call when countdown completes
period = Time period in seconds

[{CountDown counter="Alerts" action="doAction" period="10"}]

CrumbTrail

Displays a page hierarchy breadcrumb trail

Parameters

None

[{CrumbTrail}]

DataTable

Creates an interactive data table with actions

Parameters

name = Name of the table (links to Table extension data)
data = Column definitions with format "Label columnName type"

[{DataTable name="myTable" data=" Site site Open openLink action "}]

Date

Displays the current date

Parameters

None

[{Date}]

DevNotes

DisplayCard

Creates a display card with optional image, title, description, and link

Parameters

linkURL = URL for the card link
linkText = Text for the link button
title = Card title
description = Card description text
imageURL = Optional image URL for the card

[{DisplayCard linkURL="#" linkText="Link" title="Title" description="Description" imageURL="http://example.com/image.jpg"}]

Form

Creates a data-entry form with various field types

Parameters

name = Form name identifier
data = Field definitions with format "Label name" or "Type: Label name"

[{Form name="myForm" data=" Name name Age age Checkbox: Has Pet hasPet Table: todo Task task, Description description "}]

Hash

Help

Creates a popup help link

Parameters

id = Unique identifier for the help popup
sourceFileName = File containing help content
sourcePageName = Page where help content is located
title = Optional title for the help link

[{Help id="test" sourceFileName="help-content.wiki" sourcePageName="/OpenForum/Extensions/Help"}]

HttpsOnly

Redirects to the https url if the user arrives via http

Parameters

None

[{HttpsOnly}]

Icon

Places an icon on the page

Parameters

name = Name of icon

[{Icon name="chart pie"}]

ImageDisplayCard

Creates an image display card with title, description, and link

Parameters

title = Card title
description = Card description text
linkText = Text for the link button
linkURL = URL for the card link
imageURL = URL of the image to display

[{ImageDisplayCard title="Open Forum" description="Open Forum - The Future" linkText="Open Forum" linkURL="https://open-forum.onestonesoup.org/" imageURL="/OpenForum/Images/open-forum-dog-small.png"}]

Info

Creates an info popup icon

Parameters

id = Unique identifier for the info popup
sourceFileName = File containing info content
sourcePageName = Page where info content is located
title = Optional title for the info popup

[{Info id="test" sourceFileName="popup-content.wiki" sourcePageName="/OpenForum/Extensions/OneTimePopup"}]

InputBoolean

Creates a boolean checkbox input field with data binding

Parameters

id = Variable name for data binding
text = Label text for the checkbox

[{InputBoolean id="myValue" text="My Value"}]

InputField

Inserts a form input field

Parameters

name = Field name
value = Optional default value

[{InputField name="myField"}]

InputFileName

Creates a filename input field with validation

Parameters

id = Variable name for data binding

[{InputFileName id="myPage"}]

InsertFile

Inserts a file's contents into the page

Parameters

pageName = The page where the file is attached (optional, default = current page)
fileName = The file to insert

[{InsertFile pageName="pageName" fileName="fileName"}]

InsertNotes

Inserts a file's contents into the page as notes

Parameters

pageName = The page where the file is attached (optional, default = current page)
fileName = The file to insert

[{InsertNotes pageName="/OpenForum/Extensions/InsertNotes" fileName="notes.txt"}]

InsertPage

Inserts the contents of one page into another

Parameters

page = The page to insert content from
section = Optional section number of the page to insert

[{InsertPage page="/OpenForum/PageTemplates/Example" section=""}]

InsertSourceFile

Inserts a file's contents into the page as source code

Parameters

pageName = The page where the file is attached (optional, default = current page)
fileName = The file to insert

[{InsertSourceFile pageName="/OpenForum/Extensions/InsertSourceFile" fileName="data.json"}]

LinkButton

Creates a button that links to a URL

Parameters

href = URL to link to
target = Link target (e.g., "externalTab", "_blank")
text = Button text

[{LinkButton href="https://www.bbc.co.uk" target="externalTab" text="BBC"}]

ListField

Inserts a form input field with a datalist for autocomplete

Parameters

name = Field name
list = Name of the datalist
value = Optional default value

[{ListField name="beetle" list="names"}]

MarkDown

Renders markdown formatted text in a page

Parameters

pageName = Page where markdown file is attached (optional)
fileName = Name of markdown file to render
url = Alternative: URL of remote markdown file

[{MarkDown pageName="/OpenForum/Extensions/MarkDown" fileName="example.md"}]

MarkPage

Marks a point in a page that can be referenced

Parameters

name = Name of the mark

[{Mark name="TestMark"}] Some text to reference

OneTimePopup

Creates a popup that displays once per user session

Parameters

id = Unique identifier for the popup
sourceFileName = File containing popup content
sourcePageName = Page where popup content is located
suppressText = Text for the close/dismiss button

[{OneTimePopup id="test" sourceFileName="popup-content.wiki" sourcePageName="/OpenForum/Extensions/OneTimePopup" suppressText="Make this go away"}]

OpeningTimes

Creates a weekly opening times schedule display

Parameters

mondayOpen, mondayClose = Monday opening and closing times
tuesdayOpen, tuesdayClose = Tuesday opening and closing times
wednesdayOpen, wednesdayClose = Wednesday opening and closing times
thursdayOpen, thursdayClose = Thursday opening and closing times
fridayOpen, fridayClose = Friday opening and closing times
saturdayOpen, saturdayClose = Saturday opening and closing times
sundayOpen, sundayClose = Sunday opening and closing times

[{OpeningTimes mondayOpen="09:00" mondayClose="17:00" tuesdayOpen="09:00" tuesdayClose="17:00"}]

Popup

Creates a popup modal dialog

Parameters

id = Unique identifier for the popup
sourceFileName = File containing popup content (optional)
sourcePageName = Page where popup content is located (optional)
content = Inline content for the popup (optional)
title = Title for popup button (optional)

[{Popup id="test1" sourceFileName="popup-content.wiki" sourcePageName="/OpenForum/Extensions/OneTimePopup"}]

RecaptchaButton

A button that checks you are not a robot using reCAPTCHA

Parameters

action = Button javascript function name
text = Button text

[{RecaptchaButton action="alertMe" text="Am I A Robot ?"}]

Redirect

Redirects the page to another page

Parameters

page = The page to redirect to

[{Redirect page="new page name"}]

RenderFile

Renders a file fragment into the page

Parameters

pageName = Page where the file is attached (optional, default = current page)
fileName = Name of the fragment file to render

[{RenderFile pageName="/OpenForum/Extensions/RenderFile" fileName="example-list.fragment"}]

ScriptClip

Displays a small line of text on the page with a button to transfer it to the clipboard

Parameters

script = The text to display
fileName = Alternative to script - the file to display as a clip

[{ScriptClip script="ls -la /open-forum/content"}]

ServerActionButton

A button that fires an OpenForum GET action on the server

Parameters

action = Action Name
text = Action button text
parameters = Optional parameters to pass to the action

[{ServerActionButton action="Rebuild" parameters="pageName=Home" text="Rebuild Wiki"}]

Star

Table

Creates an editable data table

Parameters

name = Name of the table
actions = Comma-separated list of actions (add, edit, move, remove)
data = Column definitions with format "Label columnName type"

[{Table name="myTable" actions="add,edit,move,remove" data=" Site site Link url link "}]

TextDisplayCard

Creates a text display card with title, description, and link

Parameters

title = Card title
description = Card description text
linkText = Text for the link button
linkURL = URL for the card link

[{TextDisplayCard title="Open Forum" description="The future" linkText="Open Forum" linkURL="https://open-forum.onestonesoup.org/"}]

Thumbnail

UploadFileInputField

Creates a file upload input field

Parameters

name = Field name
targetPageName = Page to upload the file to
text = Button text
message = Message to display after successful upload

[{UploadFileInputField name="upload" targetPageName="/Sandbox" text="Upload" message="File Uploaded"}]

WysiwygInput

Creates a WYSIWYG (What You See Is What You Get) text editor input field

Parameters

name = Field name for data binding
value = Optional default value

[{WysiwygInput name="myText" value="1234"}]