README: How to use this library
 • Plugins • EnsemblePlugin • FirstMagicSettings • Widgets • README: How to use this library
 
README

How to use this Library

Grab a Widget by pressing the ALT key while dragging it from the Library and into your website.
This will produce a fresh copy where you drop it. Do NOT try to edit it IN the Library - always make a copy.

FirstMagic Widgets can be published in four different locations:

The Website Sidebar [/Content/Sidebar/]
Drop the Widget directly into the Sidebar container: it will not work in sub-containers.

The Website Footer [/Ensemble/SiteWidgets/]
Drop the Widget into the SiteWidgets folder.

The Digital Signs Sidebar [/DigitalSign/]
Drop the Widget onto the Sign/Calendar icon. It will become accessible in the Tasks List.

The Digital Signs Footer [/Ensemble/SignWidgets/]
Drop the Widget into the SignWidgets folder.

It is possible to drop Widgets into any container, but they will only be displayed on the web if they reside in the above locations. Widgets will not be displayed in the Mobile Interface.

You can turn each Widget On/Off by opening it and checking [1].

In FM Preferences, Tab 4, you can also turn the SiteWidgets and SignWidgets folders On/Off - which will turn all widgets On/Off in one go. There is also a checkbox there to make SiteWidgets sticky - that is, fix them along the screen´s left edge.

Configuring a Widget

widg.pngLeft: click to enlarge the image

1: turns the Widget On/Off.

2: opens a dialog where you can specify the filename of which pages you want the Widget to appear on. It will then only show up there. The filename is the Object Name of the page in question. You can add several pages here, with a space between each. If you select "Globally", the Widget will appear everywhere exept for on system-generated pages [the SiteMap, in regular Calendars, and on Forms].

3: some Widgets have a "Button" Mode - activating it turns it into a simpler version of itself, displayed as a large button. Some Widgets have  options for further customization.

Title: if the Widget has a visible title, you can edit it here.

Widget ID: the Object Name of the Widget. This is for internal use only; you can change it if you need to - for example for sorting purposes.



Tips and Tricks

Interactive Widgets - like Chats, Comments, Social Buttons, etc. will not be displayed on pages you have set to be ReadOnly in their respective Properties windows.

Formatting: Widgets will inherit the formatting of the web page it is on - the Skin Design - unless you check the "Manage Widgets" checkbox on the SkinDesigner Tab in FM Preferences. Manage Widgets will automatically format all Widgets into a "dark glass" style [with a few exceptions].

Some Widgets will ask for metadata, address information, or the like, to function properly. If you have filled in the Meta fields on Tab 2 in FM Preferences, you can leave such fields blank. If you input information in them while also having the Meta Tab filled in, the Widget Field will override the FM Preferences Field. This makes it possible to, for example, add several different Skype Me-buttons.

You can have multiple instances of the same Widget running on the same page. For example several YouTube clips, or two different Weather reports.

Troubleshooting
Q: There is no SiteWidgets or SignWidgets folder in my Ensemble?

A:
These folders were introduced with FirstMagic 1.4.0. If your website was created earlier than that, it will not have them. If this is the case, simply create them:

/Ensemble/SiteWidgets
     and
/Ensemble/SignWidgets

... Then fill them with the Widgets  you like from the Library.

Q: I activated a Widget, and it gives off a red error box on the web page

A:
The Widget in question does not have a function that could be performed on that particular page. For example, the Commenting Widget will not work on the Digital Sign simply because there is no way anybody would be able to create a comment on a public monitor.

Q: I activated a Widget, and it does not show up at all

A:
Check that:
  • The page is not set to ReadOnly and the Widget is a social function
  • The Widget isn´t specified to show up on a particular page only
  • The Widget do not reside in the wrong place (for example, it will work in the Sidebar, but not in sub-containers inside the Sidebar]
  • The page in question isn´t a System Page [A Form, a Calendar Object, a Search, or the SiteMap]
  • Any required Metadata is filled in properly, either in FM Preferences, or in the Widget itself
Admin Information

Do not change or edit the Widget Library or anything inside it: the Library is automatically maintained by the FirstMagic Installer, and any changes to it will be lost the next time FirstMagic is updated. Instead, build your own Library in /Plugins/EnsemblePlugin/Ensemble/SiteWidgets and SignWidgets: these containers will not be touched by updates, and can be syndicated across all your domains with the Ensemble Site Conductor, or by aliasing them to User Desktops.