Your browser does not support JavaScript!
an image an image
Hillsborough County Public Schools logo
School Logo This is an image for the page banner This is an image for the page banner
This is an image for the page header
Special Syntax for links and formatting in RWD
Special Syntax for links and formatting in RWD

This document describes the numerous ways to create links or create special formats in the content rendered on your website in RWD.  It is intended for an advanced user who wishes to accomplish functionality beyond that found in the standard RWD experience.  The links and parameters can be used regardless of which level of RWD builder you are however.


Parameters and Special Tags



IMPORTANT NOTE
In all examples below, we will use the letters 'URL' to denote the path and name of a target object such as an RWD web page, other web page, graphic file, document, or other object such as a calendar or conference, or any other addressable object such as an external web page or file.      

The URL will ALWAYS mean the entire address of the object as required by the link - meaning that if the object is not in the same container as the link that is calling it, you must also include the PATH to the object.   For clarity in the following documentation, we use a descriptive prefix to the URL to denote the kind of object you are referencing - eg. Calendar URL means the path (location) and name of the calendar you wish to reference.

Eg.  for an image file,  the File URL means path/filename  or, for example,  siteimages/mypicture.gif
    
Eg.  for a web page,  Page URL means path/pagename or, for example   /teachers/mr_jones/activities  or  http://www.mysite.com/teachers/mr_jones/activities (this last URL is a fully qualified URL)

RWD Links Syntax examples for use when linking to Content From the Page Body (these will also work in the nav, and header links)
Object to display
Link Syntax
(italic text is object path and name)
Set to Open in New Window?
Comments
Web Pages, Documents, Files
RWD Page, Other web page or file located on the local server / website (relative link)
URL

(Eg.  Anyfolder/anysubfolder/homework)
Either- recommend same window
This is the most common method of linking to other pages in a user's site
RWD Page, Other web page or file located on the local server / website (qualified link)
URL  (starting from the root of the site using the / character)

/path from root of site/object name  

(Eg.  /school_graphics/animals/cute/bunny.gif)
Either - recommend same window
the first / character (the slash) indicates to FirstClass to start at the root of the site (the site container itself).  The path will be longer than in a relative link but this syntax is very useful when resources (such as graphics) are stored centrally on a site. The / is used for all links in the RWDE Administrator form as objects referenced in that form need to work in all pages and links must be fully qualified.
RWD Page, Other web page or file located on the local server / website or any other website (fully qualified link)
URL  (with full  http://siteURL/path/object syntax)

(Eg. http://www.mysite.com/school_graphics/animals/cute/bunny.gif
Copy and paste the address from the browser address bar right into the RWD Page Builder form.  Any page or file on any website can be addressed using this syntax
LIGHTBOX / Modal View
RWD Page, Other web page or file located on the local server / website or any other website (fully qualified link)

URL  (with full  http://siteURL/path/object syntax)

(Eg. http://www.mysite.com/school_graphics/animals/cute/bunny.gif

double-click to enlarge
You MUST Use named window and set the target to one of:
rwd_lightbox
rwd_lightbox_iframe


The lightbox method allows for linked to content to appear right on top of the current page in a modal window or lightbox that can render local web pages, images, files (pdf) in sophisticated ways.
the rwd_lightbox target will present the lightbox using an AJAX method (which may or may not fit the content of the URL in the modal window, while the rwd_lightbox_iframe will load the entire URL into an iframe.
Important:  If the URL you are calling will contain links or redirects to other URL's, use the rwd_lightbox_iframe window:

rwd_lightbox_iframe: force the link to open in an iFrame in the lightbox. Usually used for opening external webpages (such as Google or an app you created), pages with links, submit buttons etc., pdf files. Downside: it can't be resized by the content - so if the first URL is a small page (like a login box), the lightbox won't grow to fit the next page after the user logs in.

rwd_lightbox: Good for displaying some simple objects such as static images, youtube videos, webpages without any links or buttons in it. It can resize to the content dimensions automatically
Other kinds of Links
The last web page visited in the current web browser window
javascript:history.back(-1);
Same window ONLY, NOT New - this link will NOT work if you open it in a new window
This link, if typed exactly, will move the view in the browser window to the last visited page.
Note that FirstClass page Body links default to open in a new window - you must change this in order for the link to work.
Create email message
mailto: target email address

NA
There are other elements to the syntax that can be added to set subject, etc however this is the basic syntax
Mashup Tabs - Identifying, Hiding, Linking
Mashup - manually add this parameter to a mashup page address in your browser to reveal the tab ids of all tabs on that page

 UTILITY FUNCTION
MashupPageURL?findrwdmashuptabid=

Note: This function is of limited value; it is quite easy to determine a mashup panel's ID simply by looking at the web page: Each mashup column is numbered (1-3 from left to right) and then sequenced from the top down, starting with 0.  The actual panel ID is comprised of this location along with the preface 'pTab'.  Eg: The third panel of the second column of a mashup page would have the ID:  pTab22
NA
This link syntax is meant only to be used by the site administrator on a specific mashup page to reveal the panel ID numbers for that page.  It is NOT a link to be used on your website except in this one-time circumstance.
Note - if a mashup panel has only one tab, its ID will not be displayed because the first tab automatically has the focus and no references are required to display that specific tab

Open a web page and set the focus on a  specific Tab in a Panel with multiple tabs
Mashup Page URL?panel_ID=Tab_ID
EG:  Site URL/mymashuppage?pTab11=2
This syntax will work when called from the current page and the target mashup tab is also on the current page but it will force a refresh of the entire page)
Either
This method uses the URL of the page and then instructs a specific tab to open (get the focus) on a specific panel.  Use this method when linking to a mashup page from another page.
Set the focus on a specific tab in a Panel with multiple tabs  on the current page
javascript:panelIDvar.expandit(Tab_ID)
Eg: the following will activate the second tab (TabID = 1 - remember, start at 0) on the second panel in the first column (panelID = pTab11)
javascript:pTab11var.expandit(1)    (current page is assumed)
Same Window (no change in page)
This method uses a javascript function to set the focus on a specific tab in a specific panel.  Use this method when the link is located on the same page (Navigation Sidebar, Information Sidebar, etc.,  or in another panel) as the tab that is being targeted.
Activate next adjacent tab in a multi-tab panel
javascript:panelIDvar.cycleit('next')
Eg:
javascript:pTab11var.cycleit('next')
Same Window
Activate previous adjacent tab in a multi-tab panel
javascript:panelIDvar.cycleit('prev')
Eg:
javascript:pTab11var.cycleit('prev')
Same Window
Rotate (cycle) through all tabs on a specific panel
MashupPageURL?panelIDvar_rotate=change frequency in seconds
Eg:
?pTab11var_rotate=4   (same page, 1st column, 2nd panel, 4 seconds on each panel)
otherpage?pTab20var_rotate=6  (different page, 2nd column, 1st panel, 6 seconds)
Either
If calling this function from the same page as the target mashup panel, you do not need to put the page URL in the syntax.

Note: this functionality can be used in conjunction with the parameter to hide the mashup tabs in a specific panel to accomplish a 'content slideshow' where multiple pages of content (text, images, etc) can be made to cycle through automatically.
Hide Mashup Tabs
rwdhidetabparameter=1
(omit entire parameter to show tabs)
When applied to any URL to be displayed in a mashup panel, this parameter causes the tab(s) for that panel to be hidden.  

The parameter need only be applied to any one of the rows in a particular group of items and all tabs in that panel will be hidden.




RWD Special Tags (Parameters) Syntax examples for use when creating special formatting options
Category of Function
Syntax
Effect / Comments
Limits / Works on Which Objects
Images
[img=path/filename]

Places an image at whatever point the syntax is inserted.  You may have text on either side of the syntax or both.
You must include the square brackets.

This feature works on the following objects:
Scrolling Message (one in each message),
Information Sidebar,
Title,
Body,
Link fields,
Page Footer (RWDe Admin Form Only)
Navigation Sidebar Link format
[color=var][hover=var][bullet=var]

var represents a valid variable for the control:
colors can be recognized words such as red or blue, or they can be actual color codes like #ffffff
Bullet variables are simply the path and filename of the bullet.

This overrides the settings in the Modify Colors and Fonts SubTab of the Navigation Sidebar for the link in which the syntax is used.  All other links will appear as the settings in the form dictate.  
You must include the square brackets.
You may use one or two or all of the parameters and colors may be in simple form (words) or code.
1). The parameters are color=, hover= and bullet=.
color= refers to the link text color, hover= refers to the color the link will become when a mouse-over occurs and bullet= refers to an image that will appear in front of the link text.
2). Don't use double quotes ". Single quotes ' like [color='red'] or no quote like [color=red] are acceptable.
3). The order doesn't matter and the options/components of the parameter can be used individually.  

All of the examples below are valid:
[color='red'][hover=#123456][bullet=dot_pink.gif]
[hover=#123456][color='red'][bullet=dot_pink.gif]
[hover='#123456'][bullet=siteimages/dot_pink.gif]
[hover=#123456]
[bullet=dot_pink.gif][hover=#123456]

Notice that you should NOT put the & character between these options like you would between parameters.

This feature works on links in the Navigation Sidebar Only.

Note, when using paths to images in the RWDe Administrator form (.sitepref), make sure that paths are absolute and referenced from the root of the site.  Adding the / at the beginning of the path will signify that the path starts from the root.
Iframes
[iframe src='var' height='var' width='var']

var represents a valid variable for the control:
src requires a valid URL for the source of the frame while height and width variables are in pixels.

Square brackets and single quotes must be used.
Iframes can be used to contain any number of objects - from simple HTML, Firstclass documents, web pages, Flash, etc.  It is important however that the content's original size be the same as the Iframe height and width or only a portion of the content will be visible.
[iframe src='http://url.com']
[iframe width=234pt src='http://url.com' height=80]
[iframe height='80' src='http://url.com']
[iframe height=80 width='234pt' src=http://url.com]
These tags can be used to generate frames in both the Navigation Sidebar and the Information Sidebar.

You may also use Iframes in the Page body itself (using the Literal HTML style option) and then you are free to use the full Iframe syntax.
The following code would be used to display a Flash object we created in the Information Sidebar or Navigation Sidebar (we don't on our website but we could if we wanted to):

[iframe src='/flash/RWD_Flash.html?FCItemID=S000478C9&DF0=0' height='200' width='175']

The following code represents the code actually used in the (old, no longer available online) FirstClass Depot Home Page to display the same flash in the Page Body of the form - note, all text is formatted as Literal HTML and the iframe syntax is NOT the same as the RWD special syntax.

<table><tr><td><iframe marginheight="0" marginwidth="0" name="wxButtonFrame" id="wxButtonFrame" height="200" src="/flash/RWD_Flash.html?FCItemID=S000478C9&DF0=0" align="top" frameborder="0" width="175" scrolling="no"></iframe>
</td></tr></table>

Hint:  you should open the object directly in a browser first to identify the FirstClass ID of the item because using the Name itself is a bit unreliable.

Maximum Depth of AutoNav Menu
max_layer=var
where var is a number
When applied to any AutoNav URL (a link to an AutoNav container WITH the AutoNav Sepcial Format selected), this parameter will override the default maximum number of flyout menus (nested container links) in the menu.  The default value is 3 so you may use this parameter to change that value to any number higher or lower.
Applies only when linking to a container while using the AutoNav Special format.



Parameters Used only in Mashup Pages
When using these parameters, the first parameter is preceded by the ? character and any others are preceded by the & character
Category of Function
Syntax
Effect / Comments
Limits / Examples / Applies to Which Mashup Objects
Scroll Speed or Transition Speed
speed=var

where var is a number in milliseconds or seconds  (depending on the object it is being applied to)


When applied to the Scrolling Container special format setting, causes the speed of the listing in a scrolling mashup panel to be adjusted up or down from the default speed.  The higher the number, the slower the scroll speed.  The default speed is 250 (milliseconds).
Applies only to the following Special Format Settings:

Scrolling Container - measured in milliseconds (250 is the default)
When applied to the Slideshow special format setting, causes the refresh rate of the images to speed up or slow down.  The higher the number, the longer a given image will remain in the display before the next is shown. The default is 4 (seconds).

Slide Show - measured in seconds (4 is the default)
When applied to the Rotating Preview Container special format setting, causes the focus to move through the icon panel from item to item at different speeds. The higher the number, the slower the rotation (ie. the longer the focus will stay on a particular icon in the list).  The default is 3 (seconds).

Rotating Preview Container - measured in seconds (3 is the default)
Number of items displayed in a list
displaynumber=var

where var is a number (integer)
When applied, this parameter sets the number of conference items displayed in the particular object displayed in the mashup, overriding the default settings for that object's special format.
Applies only to conference listing items - using the following Special Format Settings:

Static Container  (default is 6 items)
Preview Container (default is 3 items)
Rotating Preview (default is 4 items)

Display last modified date
msgdate=1
(omit parameter for no date)
When applied to any conference or folder listing special format, displays the last modified date of items in the list
Applies only to conference or folder listing items
Display Thumbnail
displaythumbnail=var

where var is either 1 or 0
When applied to the Static Container Special Format, the setting includes any thumbnail image associated with a particular posting if one exists

When applied to the preview container listing, the setting removes any thumbnail image associated with a particular posting if one exists
Applies to the static container (default is no thumbnail) and the  Preview Container (default is to display a thumbnail) views.
Hide Mashup Tabs
rwdhidetabparameter=1
(omit entire parameter to show tabs)
When applied to any URL to be displayed in a mashup panel, this parameter causes the tab(s) for that panel to be hidden
The parameter need only be applied to any one of the rows in a particular group of items and all tabs in that panel will be hidden.
Maximum Depth of AutoNav Menu
max_layer=var
where var is a number
When applied to any AutoNav URL (a link to an AutoNav container WITH the AutoNav Sepcial Format selected), this parameter will override the default maximum number of flyout menus (nested container links) in the menu.  The default value is 3
Applies only when linking to a container while using the AutoNav Special format
Blog Preview Thumbnail Border
thumbnailborder=0

Using this parameter in any URL that points to a conference with messages that have thumbnails will cause the border around the thumbnail to become transparent.
Only Applies to the Preview Container List special format
Blog Preview Thumbnail Image Width
thumbnailwidth=var
Changes the thumbnail image for the blog post to a specific width - overriding the default setting which is the original width of the thumbnail image, up to 180 pixels.
Only Applies to the Preview Container List special format
Dividing Lines Between Blog Posts
dividers=0
Removes the default dividing lines between blog posts
Only Applies to the Preview Container List special format
Link To Open Blog Post
fullstory=<string>
where <string> is a text string
Overrides the text indicating that more of the post is available (the link that triggers the opening of the blog post).
Only Applies to the Preview Container List special format
Special Override parameters for the List View of the Message Blog (all versions).  Note, these parameters are not required if you are using a config form associated with the URL of the Blog  
Number of items displayed per page
displaynumber=Var
where Var is a number
Sets the number of blog posts that will display per page in the blog list view when a user clicks on the view all (or equivalent) link
Only Applies to the message blog listing that appears when a user clicks on the view all items link.
Hide Message Date in Blog Post
msgdate=0
where Var is a number
changes the default behaviour of RWD and hides the message posted date as displayed in the list view of the blog
Only Applies to the message blog listing that appears when a user clicks on the view all items link.
Set Thumbnails to a common width
thumbnailwidth=Var
where Var is a number
isplay per p
Only Applies to the message blog listing that appears when a user clicks on the view all items link.
Supress Thumbnail image border
thumbnailborder=0



Legacy Features - NOT RESPONSIVE        RWD Featured / Preview Content Slider Parameters Table
Parameter
Meaning
Value example
Default
parameter or Field
maxpreview
max length of preview displayed
bytes
whatever is current default we have
parameter only
plbgc0
Preview link background color
cfcfcf
Mashup Content Panel "Font Color" on RWD form
parameter on form, field on .sitepref
plbgc1
Preview link background color (selected)
cfcfcf
Mashup Content Panel "Background Color" on RWD form
parameter on form, field on .sitepref
plbgimg0
Preview link background image (path/file)
/Siteimages/PL/Plbg.gif
none
parameter on form, field on .sitepref
plbgimg1
Preview link background image (selected) (path/file)
/Siteimages/PL/Plbgs.jpg
none
parameter on form, field on .sitepref
pltcolor0
Preview link Text color
cfcfcf
Mashup Content Panel "Background Color" on RWD form
parameter on form, field on .sitepref
pltcolor1
Preview link Text color (selected)
red or #cfcfcf
Mashup Content Panel "Font Color" on RWD form
parameter on form, field on .sitepref
plsl
Preview link max subject  text limit to be cut off
20
18
parameter only
cpimgalign
Content panel image alignment
top or left or right
left
parameter on form, field on .sitepref


RWD Document Slideshow Parameters Table
(Note: these parameters are not needed if you use a config form associated with this object)
Parameter
Meaning
Value example
Default
parameter or Field
displaynumber=n
where n is an integer
The number of items displ
4
not set - depends on page dimensions
Parameter only
msgdate=0
Turns off the message date in the display - which is ON by default
0
true - the documents will cycle automatically


Parameter only
controls
Sets the controls displayed to either full set (that displays a control for each document in the container) or a basic start / stop control set
simple or full
none - no controls are displayed
Parameter only
elementsinpage
Determines how many documents will display at once in the panel
2
1 (document at a time)
Parameter only
background-image
Sets a background image over which the documents will display
/imagepath/imagefile.jpg
none - no image displayed
Parameter only
dir
Sets the direction of the slide transition to either horizontal or vertical
vertical or horizontal
Horizontal
Parameter only
Example of a link to a container (called MyDocumentsContainer in this example) using all available Parameters:   
MyDocumentsContainer?slidetimer=800&scrolltimer=8&autoscroll=false&controls=full&elementsinpage=2&background-image=/siteimages/cool_bg.jpg&dir=vertical


The following is material related to features that are no longer used in RWD because they are not Responsive Design and are not mobile friendly.  We encourage you to NO LONGER user these objects and features



Legacy Features - NOT RESPONSIVE        AutoNav Keywords Table
The AutoNav functionality can be manipulate somewhat by entering keywords into the Category Field of the target container (use Get Info (MAC) or Properties (PC) to see the Category field for the container. The list of keywords below explains the functionality of each.   When multiple keywords are listed, ANY of the keywords will work to achieve the listed functionality.
Keyword(s)
Entered into keywords field of container
Function
Applies to Which Objects inside container
Notes
month, monthly
Will display calendars in the AutoNav container using the RWD Monthly Calendar View when opened (clicked)
Calendars only (including FC Web Publishing Calendars)
week, weekly
Will display calendars in the AutoNav container using the RWD Weekly Calendar View when opened (clicked)
Calendars only (including FC Web Publishing Calendars)
day, daily
Will display calendars in the AutoNav container using the RWD Daily Calendar View when opened (clicked)
Calendars only (including FC Web Publishing Calendars)
punch through
Will display the calendar in layers if the calendar has any punch-through sub-calendars inside
graphics, images, gallery, image
Will display RWD Graphics Gallery Containers that have been added to AutoNav Containers properly on the web when opened (clicked)
RWD Graphics Gallery containers
Graphics Galleries that are located inside AutoNav Containers should have their Home Page documents removed.  

NOTE: the RWD Graphics Gallery does not function properly when dragged into a FirstClass Personal Web Publishing folder
hide, hidden, invisible
Will cause an object (container) inside an AutoNav container to remain hidden (unlinked) in the AutoNav menu
Any container object (blogs, folders, calendars, etc.)
Primarily used for the Backups container that is included with the Class AutoNav template in the Site Objects Picker
blogs, blog
Will display the contents of the container in the RWD Message Blog format when opened (clicked)
RWD Blog containers, Conferences, FC Personal Web Publishing Blogs
nosubmenu, no submenu
Will cause the container itself to be listed in the AutoNav menu but will disable the flyout menu showing the contents of the container
Containers and Calendars
target='_new'
Will cause the object to be opened in a new window
Containers and Calendars** see note
Calendars will open in a new window with this keyword, however, they will lose their RWD formatting and revert to pure FirstClass web calendars.
modal, lightbox
Calendars and documents
The modal or lightbox keyword works by itself on calendars and documents, causing them to be opened in a modal window when clicked.  The modal or lightbox keyword must be combined with the gallery keyword in order to display the contents of a container (folder or conference) in a modal view.
modal gallery
shows the contents of a container (folder or conference) in a modal window with navigation between the objects
Folders and Conferences
See the chart below for an explanation of the objects that can be viewed using the modal view
Documents
modal view shows entire document in the modal window (iframe)
files
if the browser supports the file, it will display or play in the modal window, if not, it will ask for hte application needed to open the file or offer a download (depending on the browser
sub containers and calendars
ignored
images
show image with option to view in a full gallery
documents with a URL as the name of the document
will display the content (Youtube,l Flicker, facebook video, yahoo movie, picassa, teachertube)


Legacy Features - NOT RESPONSIVE        RWD Rotating Preview Parameters Table
Parameter
Meaning
Value example
Default
parameter or Field
maxpreview
max length of preview displayed
bytes
whatever is current default we have
Parameter only
plbgc0
Preview link background color
cfcfcf
Mashup Content Panel "Font Color" on RWD form
parameter on form, field on .sitepref
plbgc1
Preview link background color (selected)
cfcfcf
Mashup Content Panel "Background Color" on RWD form
parameter on form, field on .sitepref
plbgimg0
Preview link background image (path/file)
/Siteimages/PL/Plbg.gif
none
parameter on form, field on .sitepref
plbgimg1
Preview link background image (selected) (path/file)
/Siteimages/PL/Plbgs.jpg
none
parameter on form, field on .sitepref
pltcolor0
Preview link Text color
cfcfcf
Mashup Content Panel "Background Color" on RWD form
parameter on form, field on .sitepref
pltcolor1
Preview link Text color (selected)
cfcfcf
Mashup Content Panel "Font Color" on RWD form
parameter on form, field on .sitepref
plsl
Preview link max subject  text limit to be cut off
20
18
parameter only