Developer

API

These Javascript methods can be used to control or update the widget via the global taggWidget object.

Please test for this object before using it, to avoid the possiblility of JS errors if the widget is not present for any reason.
i.e. if (window.taggWidget) {...}

enableEl(domElement)

Create the taggstar UI on a DOM element at any time.

Note: the visiblility of the UI will depend on your site's config settings (also see showBar() below.) if(window.taggWidget)taggWidget.enableEl(document.getElementById('myImg'));

disableEl(domElement)

Completely remove the taggstar UI from a DOM element. if(window.taggWidget)taggWidget.disableEl(document.getElementById('myImg'));

reparse()

Re-examines the page to create the taggstar UI on images that were not present (or not identified as taggable) on load.

This will not reprocess images that are already tagg-enabled. if(window.taggWidget)taggWidget.reparse();

isDisplayActive()

Detects if any part of the taggstar UI is currently engaged by the user. var isDisplayActive = window.taggWidget && taggWidget.isDisplayActive();

viewTagg( domElement, taggId )

Displays a tagg and it's balloon automatically.

The taggId can be found by inspecting the marker in a web console, it is the middle numeric part of the wrapper id.
i.e. tagg_tagHandle_124_0 is taggId 124. if(window.taggWidget)taggWidget.viewTagg(document.getElementById('myImg'), 124);

quitUI( domElement, hideInactiveUI )

Quits (and optionally completely hides) any taggstar UI for a specified DOM element i.e. the img, div etc. which is tagg-enabled.

If no second parameter is supplied, the UI will just quit (which may still show elements depending on your config settings.)

If the second parameter is 'true', any visible inactive UI will also hide.

The UI will be re-activated from a reset state if the user mouses over it. if(window.taggWidget)taggWidget.quitUI(document.getElementById('myImg'), true);

quitAll( hideInactiveUI )

Quits all active taggstar UIs on the page i.e. balloons hide, any editing quits, taggs hide (unless set to always visible) etc.

If no parameter is supplied, the UI will just quit (which may still show elements depending on your config settings.)

If the parameter is set to 'true', any visible inactive UI will also hide.

All UIs will be re-activated from a reset state if the user engages with them again. if(window.taggWidget)taggWidget.quitAll(true);

suspend()

Quits all active taggstar UIs on the page and disables the widget until reactivated by reactivate(). if(window.taggWidget)taggWidget.suspend();

reactivate()

Reactivates the widget after suspend(). if(window.taggWidget)taggWidget.reactivate();

showBar()

Forces the taggstar bar to show on all images. This can be useful for taggers and developers, when images are tagg-enabled but nothing is visible due to config settings. if(window.taggWidget)taggWidget.showBar();

Help

Adding/Editing Taggs

If you are not yet logged in to taggstar, clicking the taggstar icon (star) on a photo will prompt you to log in. After logging in, clicking the icon will take you into the editing modal.

You can also right-click an existing tagg to enter edit mode for that tagg.

If no UI is showing due to config settings, use the 'show taggstar' bookmarklet (below).

Image settings and metadata

There is a cog button on the top bar of the editing modal. Hover over it to see options for image related settings and data.

If you disable an image it will no longer show the taggstar UI. To temporarily show the UI for editing use the 'show taggstar' bookmarklet (below).

Tagger bookmarklet

If the icon is hidden and there are no existing taggs, there is no way to log in to taggstar on the page.

This bookmarklet will force the taggstar bar to show.

« Right click, then bookmark this link, or drag the link onto your browser's bookmarks toolbar.

Click the bookmark when on a page that has taggstar installed. The icon will be displayed on all tagg-enabled images.

Debug bookmarklet

This bookmarklet will display information about the taggstar install on a page.

« Right click, then bookmark this link, or drag the link onto your browser's bookmarks toolbar.

Click the bookmark when on a page that has taggstar installed. Installation data will be outputted to the javascript console.

Caching

It's a good idea to clear your browser's cache if things are not displaying as expected.

If new taggs or changes to taggs are still not showing, it is probably because you are seeing the cached version from the server. To check this, try entering edit mode again. The cache is always circumvented when you are in edit mode - all taggs, balloons and ads are made up-to-date and will be present until the page is reloaded.

Troubleshooting checklist

If the taggstar UI, or taggs for an image are not behaving as expected, please check these points.

  • Is the taggstar JS code on the page? Has your site id been inserted? i.e. site = "yourSiteName".
  • Has the JS code been altered in any way by your platform or CMS?
  • Are you viewing a cached version of the page or the taggs? (see 'Caching' above.)
  • If using 'auto-detect', do the image dimensions fall within the criteria set in the admin panel? If the image is a css background, 'auto-detect' will only include DIV elements. (All elements are included for other methods.)
  • If marking images individually, has the method been inserted correcty? i.e. class="taggstar" or similar. Also, check that the class attribute is not included twice as this may overwrite.
  • If existing taggs are not showing, is the img src the same as it was previously? (not including http/https.)
  • Has someone 'disabled' the image? You can check this by logging in as administrator and entering edit mode on any img (see above). After that, disabled images will show a greyed out taggstar icon.
  • If the image seems to be tagg-enabled when it shouldn't be, do you have 'auto-detect' setting on in the config?
  • If elements of the taggstar UI are not showing, or not hiding, has this been set in the config options?
  • Have you cleared your browser's cache? Is javascript switched on in your browser?
  • If you are still having problems, please contact Taggstar for help.