|
The Settings XML File
All configurations settings for the toolbar itself are set in an
XML file. These settings include which options are enabled, which
fonts, colors and styles are available, the tooltips for each
button and all of the captions for the forms. This page outlines
the options available for each node.
|
Page Variables
|
Popup Form Labels
Registration
Blog Settings
|
Version Declaration:
<?xml version="1.0"?>
XML documents require a version declaration:
Root Node:
<Settings>
XML documents require a root node. The root node
for this document is called "Settings"
Page Variables
<PageVariables>
Settings has 3
sub-nodes. "PageVariables" contains settings used by the
toolbar itself, "PopupFormLabels" contains settings used by
the various popup forms, and "Registration" contains
registration information.
EditID
<EditID>editSpace</EditID>
- EditID contains the ID attribute used for the span
tags that define which content is editable. The default value is
editSpace, for security reasons it would be wise to change this to
a different value.
TargetPage
<TargetPage>saver.asp</TargetPage>
- TargetPage is the page to which the content is submitted.
Again, it would be wise to change this value to something
other than the default "saver.asp"
MakeLinksRelative
<MakeLinksRelative>True</MakeLinksRelative>
CheckForToolbar
<CheckForToolbar>True</CheckForToolbar>
- If someone browses to a page which has toolbar editing enabled
and they do not have the toolbar installed or active, a bar will
appear at the top of the page two seconds after the page is loaded.
The bar has options for editing and submitting content on the page,
but more advanced options are not supported. This option is meant
to be used with ASP pages that only show the toolbar scripts
to authenticated users.
- If you use this option you also have to include this code
at the top of your page:
<script language="javascript">
t=setTimeout("ToolbarCheck();",2000,"javascript")
</script>
<script id="NoToolbarScript"
src="/includes/NoToolbar.js"></script>
And, you need to place the provided NoToolbar.js file in the
appropriate directory.
HTMLTidy
<HTMLTidy>
<Enabled>True</Enabled>
<DropFontTags>False</DropFontTags>
<NumericEntities>True</NumericEntities>
<Wrap>True</Wrap>
<OutputXHTML>True</OutputXHTML>
<DropEmptyParas>True</DropEmptyParas>
<CharEncoding>ascii</CharEncoding>
<NewEmptyTags></NewEmptyTags>
<NewInlineTags></NewInlineTags>
<NewBlockLevelTags></NewBlockLevelTags>
</HTMLTidy>
This node controls the behavior of the HTML Tidy and Toolbar
code that cleans up the HTML upon submission. The nodes mean:
- Enabled: if set to true it will tidy the
HTML (Default = true)
- DropFontTags: if set to true it will remove
all font tags from the content (Default = False)
- Wrap: If set to true the filter will wrap your
HTML into smaller lines. If you are using this on a blog and have
RemoveLineBreaks set to false then this will automatically be
False, otherwise it is set to true by default.
- OutputXHTML: The content will be output
as XHTML.
- DropEmptyParas: The filter will remove empty p
tags from the content. Defaults to "true"
- CharEncoding: Can be set to: ascii,
iso2022, latin1, raw, or utf8. Defaults to ascii.
- NewEmptyTags, NewInlineTags,
NewBlockLevelTags: Lists of new, user defined tags
that you want HTMLTidy to use. If HTML Tidy finds a tag it does't
recognize it will throw an error and the HTML will not be tidied.
You can define any new tags you wish to use here.
OfficeFilter
<OfficeFilter>
<Enabled>True</Enabled>
<ConvertFontFaces>True</ConvertFontFaces>
<ConvertFontColors>True</ConvertFontColors>
<ConvertFontSizes>True</ConvertFontSizes>
<RemoveXML>True</RemoveXML>
</OfficeFilter>
The office filter controls the behavior of the Word 2000 HTML
filter. This operates independently of HTML Tidy. Enabled turns the
filter on and off, the Convert settings determine if fonts, colors
and sizes can be copied in from Word, and RemoveXML determines if
Word specific XML is removed by the filter (this XML is generally
incompatible with Netscape 4.x)
ImageEditor
<ImageEditor>
<Enabled>True</Enabled>
<ToolTip>Image Editor </ToolTip>
<ImageLocation>Images</ImageLocation>
<EditorLocation>/AT/ImageEditor.asp</EditorLocation>
<HSize>400</HSize>
<VSize>600</VSize>
</ImageEditor>
The ImageEditor node contains information about the image
button and about the window that opens when it is
pressed.
- If the enabled button is true the option is enabled.
- The tooltip node sets the tooltip for the button.
- The image location is not used.
- The EditorLocation points at the web page that opens when
the button is pressed
- The HSize and VSize nodes determine the size of this
window in pixels.
EditSave
<EditSave>
<Enabled>True</Enabled>
<ToolTip>Edit with
Adminimizer Toolbar,Save</ToolTip>
<Options>Edit
Page,View Source,Uninstall,Hide Toolbar</Options>
<CustomOption>
<OptionLocation>mypage.asp?action=add</OptionLocation>
<OptionName>Create New Page Type
1</OptionName>
<Saver>True</Saver>
<Popup>True</Popup>
<ShowToolbars>True</ShowToolbars>
<HSize>500</HSize>
<VSize>500</VSize>
</CustomOption>
</EditSave>
The EditSave node contains:
- An Enabled element (true means the edit and save buttons are
enabled)
- A ToolTip element that determines the tooltips displayed
for these buttons. The tooltips are presented in a comma delimited
list.
- An Options element that sets the text for the edit
button's drop down menu. This is also entered as a comma delimited
list.
- There can be any number of CustomOption nodes. This will
add an entry of <OptionName> to the dropdown menu on the
edit button. When clicked it will either open in a popup window
with the properties described, or it will navigate the current page
to the location in <OptionLocation>. If <Saver> is set
to True the Toolbar will submit the contents of the page to
the URL contained in <OptionLocation>.
ShowToolbars, HSize and VSize are used to describe the popup
window. Recognized values for ShowToolbars are "False",
"None" or "Scrollbars". Any other values (including
blank) will show all the toolbars in the popup window.
Help
<Help>
<HelpLocation>http://www.adminimizer.com/toolbar/help/default.asp
</HelpLocation>
<HSize>500</HSize>
<VSize>500</VSize>
</Help>
The Help node contains:
- The URL of the window that opens when "help" is selected from
the Edit button dropdown menu.
- The height and width of this window
CopyCutPaste
<CopyCutPaste>
<Enabled>True</Enabled>
<ToolTip>Copy,Cut,Paste</ToolTip>
</CopyCutPaste>
This node contains:
- An Enabled element (true means the buttons are
enabled)
- A ToolTip element that determines the tooltips displayed
for these buttons. The tooltips are presented in a comma delimited
list.
UndoRedo
<UndoRedo>
<Enabled>True</Enabled>
<ToolTip>&Undo,Redo</ToolTip>
</UndoRedo>
This node contains:
- An Enabled element (true means the buttons are
enabled)
- A ToolTip element that determines the tooltips displayed
for these buttons. The tooltips are presented in a comma delimited
list.
BoldItalicUnderline
<BoldItalicUnderline>
<Enabled>True</Enabled>
<ToolTip>Bold,Italic,Underline,PlainText</ToolTip>
</BoldItalicUnderline>
This node contains:
- An Enabled element (true means the buttons are
enabled)
- A ToolTip element that determines the tooltips displayed
for these buttons. The tooltips are presented in a comma delimited
list.
Spelling
<Spelling>
<Enabled>True</Enabled>
<ToolTip>Spell Check</ToolTip>
</Spelling>
This node contains:
- An Enabled element (true means the button
is enabled)
- A ToolTip element that determines the tooltip
displayed by this button.
Justify
<Justify>
<Enabled>True</Enabled>
<ToolTip>Jusification</ToolTip>
<Options>Left
Justify,Center Justify,Right Justify</Options>
</Justify>
The Justify node contains:
- An Enabled element (true means the button is
enabled)
- A ToolTip element that determines the tooltip displayed by
this button.
- An Options element that sets the text for the button's
drop down menu. This is entered as a comma delimited list.
Links
<Links>
<Enabled>True</Enabled>
<ToolTip>Create Link</ToolTip>
<UsePopup>True</UsePopup>
<LinksLocation>Links.htm</LinksLocation>
<HSize>400</HSize>
<VSize>200</VSize>
</Links>
This node contains:
- An Enabled element (true means the button
is enabled)
- A ToolTip element that determines the tooltip
displayed by this button.
- If UsePopup=True then the links button will popup a browser
window instead of the standard links dialog.
- LinksLocation contains the URL of the popup window.
- HSize is the horizontal size of the popup window.
- VSize is the vertical size of the popup window.
OrderedUnorderedList
<OrderedUnorderedList>
<Enabled>True</Enabled>
<ToolTip>Ordered
List,Unordered List</ToolTip>
</OrderedUnorderedList>
This node contains:
- An Enabled element (true means the buttons are
enabled)
- A ToolTip element that determines the tooltips displayed
for these buttons. The tooltips are presented in a comma delimited
list.
IndentOutdent
<IndentOutdent>
<Enabled>True</Enabled>
<ToolTip>Indent,Outdent</ToolTip>
</IndentOutdent>
This node contains:
- An Enabled element (true means the buttons are
enabled)
- A ToolTip element that determines the tooltips displayed
for these buttons. The tooltips are presented in a comma delimited
list.
Tables
<Tables>
<Enabled>True</Enabled>
<ToolTip>Tables</ToolTip>
<Options>Insert Table,Insert Row,Insert Column,Insert
Cell,
Delete Row,Delete Column,Delete Cell,Merge Cell,
Split
Cell,Edit Table,Edit Cell</Options>
</Tables>
The Tables node contains:
- An Enabled element (true means the button is
enabled)
- A ToolTip element that determines the tooltip displayed by
this button.
- An Options element that sets the text for the button's
drop down menu. This is entered as a comma delimited list.
ViewSource
<ViewSource>
<Enabled>True</Enabled>
</ViewSource>
This node contains a Enabled element (true means
the option is enabled).
Fonts
<Fonts>
<Enabled>True</Enabled>
<ToolTip>Fonts</ToolTip>
<Options>Font Properties</Options>
<FontName>Times;Times New Roman,Serif</FontName>
<FontName>Arial;Arial,Sans-Serif</FontName>
<FontName>Courier;Courier,Serif</FontName>
<FontName>Verdana;Verdana,Sans-Serif</FontName>
</Fonts>
The Fonts node contains:
- An Enabled element (true means the button is
enabled)
- AToolTip element that determines the tooltip displayed by
this button.
- An Options element that sets the text for the font color
option of the dropdown menu.
- Any number of FontName elements. The FontName
elements contain two parts: display font name;HTML font
name. The display font name is what appears in
the dropdown, the HTML font name is what is actually
inserted into the HTML.
Tags
<Tags>
<Enabled>True</Enabled>
<ToolTip>Tags</ToolTip>
<Tag>Normal</Tag>
<Tag>Formatted</Tag>
<Tag>Address</Tag>
<Tag>Heading
1</Tag>
<Tag>Heading
2</Tag>
<Tag>Heading
3</Tag>
<Tag>Heading
4</Tag>
<Tag>Heading
5</Tag>
<Tag>Heading
6</Tag>
<Tag>Directory
List</Tag>
<Tag>Menu
List</Tag>
<Tag>Definition
Term</Tag>
<Tag>Definition</Tag>
<Tag>Paragraph</Tag>
</Tags>
The Tags node contains:
- An Enabled element (true means the button is
enabled)
- A ToolTip element that determines the tooltip displayed by
this dropdown.
- A variable number of Tag elements. The
Tag elements contain the name of the formatting that will
be applied to the selected text. These tags and their
names are defined by Internet Explorer, so the list cannot be
expanded, but elements can be removed from the list.
Styles
<Styles>
<Enabled>True</Enabled>
<ToolTip>Styles</ToolTip>
<StyleName>Header
Style;headredbig</StyleName>
<StyleName>Code
Style;headblue</StyleName>
</Styles>
The Styles node contains:
- An Enabled element (true means the button is
enabled)
- A ToolTip element that determines the tooltip displayed by
this button.
- Any number of StyleName elements. The StyleName
elements contain two parts: display name;HTML class
name. The display name is what appears in the
dropdown, the HTML class name is what is actually inserted
into the HTML SPAN tag class attribute when a style is
applied.
If no StyleName elements are defined then the toolbar will
automatically retrieve any available styles from the
stylesheet.
Editable Content
<EditableContent>
<EditorOn>
<Border>thin dashed red</Border>
<Background></Background>
</EditorOn>
<EditorOff>
<Border></Border>
<Background></Background>
</EditorOff>
</EditableContent>
The EditableContent node contains information on
how the editable content is displayed in the toolbar.
- Both the EditorOn and EditorOff nodes can be used to set the
contents of the border and background settings of the style
attribute for the editable areas. By default a "thin dashed red"
border is turned on when the editor is turned on. This can be
changed to match the look and feel of the particular
page.
Office HTML Filter
<OfficeFilter>
<Enabled>True</Enabled>
<ConvertFontFaces>True</ConvertFontFaces>
<ConvertFontColors>True</ConvertFontColors>
<ConvertFontSizes>True</ConvertFontSizes>
</OfficeFilter>
The OfficeFilter node controls the behavior of the built
in filter for Microsoft Office HTML.
- Enabled enables or disables the filter
- If ConvertFontFaces is true then the filter will keep
the font faces defined in Office. This can enable
users to bring in non-standard fonts that do not match the look and
feel of the site.
- If ConvertFontColors is true then the filter will import
the font colors defined in Office.
- If ConvertFontSizes is true then the filter will import the
font sizes from Office and convert them to the closest HTML font
size (size = 1 through 7).
PageVariables Closing tag
</PageVariables>
End of the PageVariables section.
PopupFormLabels:
<PopupFormLabels>
The opening tag for the PopupFormLabels
section
EditCell Form
<EditCell>
<Sections>Width,Color,Alignment</Sections>
<Labels>Cell
Width:,Percent,Pixels,Word Wrap:,
Border Color:,None,Background
Color:,None,Row
Span:,Col Span:</Labels>
<Buttons>&OK,&Cancel</Buttons>
<FormTitle>Edit
Cell</FormTitle>
<HAlignValues>Left,Right,Center,None</HAlignValues>
<VAlignValues>Top,Bottom,Middle,None</VAlignValues>
</EditCell>
The Edit Cell form contains:
-
3 section labels in the sections element as a comma
delimited list.
-
A Labels element which contains a comma delimited
list of all of the labels on the form.
-
A Buttons element which contains a comma delimited list of the
button captions. Use "&" for the ampersand character, this
will enable the shortcut key for that key (in the example above
alt-O would be equivalent to clicking on the OK button).
-
The form title is set in the FormTitle element.
-
The contents of the HAlignValues and VAlignValues
elements will appear in the appropriate dropdown list. They will
always enter the same HTML align values regardless of the
values entered in these elements
Edit Table Form
<EditTable>
<Sections>Table Size:,Color,Border
Style,Alignment</Sections>
<Labels>Table Width:,Percents,Pixels,Columns:,Rows:,
Border Color:,None,Background Color:,
None,Border Width:,Cell Padding:,Cell Spacing:,
Table Alignment:</Labels>
<Buttons>&OK,&Cancel</Buttons>
<FormTitle>Edit Table</FormTitle>
<TableAlignValues>Left,Right,Center,None</TableAlignValues>
</EditTable>
The Edit Table form contains:
-
4 section labels in the Sections element as a comma
delimited list.
-
A Labels element which contains a comma
delimited list of all of the labels on the form.
-
A Buttons element which contains a comma delimited list
of the button captions. Use "&" for the ampersand
character, this will enable the shortcut key for that key (in the
example above alt-O would be equivalent to clicking on the OK
button).
-
The form title is set in the FormTitle element.
-
The values listed in the TableAlignValues element will
appear in the appropriate dropdown list. It will
always enter the same HTML align values regardless of the
values entered in these elements
ColorPicker
<ColorPicker>
<Enabled>
<Sliders>True</Sliders>
<Named>True</Named>
<CustomColors>True</CustomColors>
<Favorites>True</Favorites>
<WebSafeOnly>True</WebSafeOnly>
<PaletteGradient>True</PaletteGradient>
<PaletteWebSafe>True</PaletteWebSafe>
<PaletteNamed>True</PaletteNamed>
<FontSize>True</FontSize>
</Enabled>
<Labels>Current
Color:,Hex Value:,Named Colors:,
Site Specific Colors,Favorite Colors,Font
Size</Labels>
<Buttons>&OK,&Cancel</Buttons>
<CheckBox>Show
only web safe colors</CheckBox>
<OptionButton>Gradient,Web Safe,Named
Colors</OptionButton>
<cpOther>Right-click to save color,Shift and click to create
gradient,
Palette
>>>,Palette <<<</cpOther>
<CustomColor>Red;#FF0000</CustomColor>
<CustomColor>Green;#00FF00</CustomColor>
<CustomColor>Blue;#0000FF</CustomColor>
</ColorPicker>
The ColorPicker form has more options than most
of the other forms.
-
The Enabled node contains elements which control each feature
on the form. Each type of color picking on the form can be
individually enabled or disabled by setting the appropriate element
within this node to True or False. Elements that have been set to
False will not be visible to the user.
-
The Labels element contains a comma delimited
list of all of the labels on the form.
-
The Buttons element contains a comma delimited list of the
button captions. Use "&" for the ampersand character, this
will enable the shortcut key for that key (in the example above
alt-O would be equivalent to clicking on the OK button).
-
The CheckBox element sets the caption of the check box while
the OptionButton element contains a comma delimited list of the
option button captions.
-
The cpOther element contains the button captions as well as
some other captions on the form.
-
Any number of CustomColor elements. These elements contain
values in the format Color Display Name;Color HTML
name where Color Display Name is shown to the
user in a dropdown list and Color HTML name is what
is actually inserted into the FONT color attribute.
Image Properties Form
<ImageProperties>
<Labels>Image Source(URL):,Border Width:,Image
Height:,Image
Width:,Alignment:,Horizontal Spacing:,Vertical Spacing:,
Alt Text:</Labels>
<FormTitle>Image
Properties</FormTitle>
<AlignValues>left,top,right,texttop,absmiddle,baseline,
absbottom,bottom,middle</AlignValues>
<Buttons>&OK,&Cancel</Buttons>
</ImageProperties>
The ImageProperties controls the ImageProperties
form:
-
The Labels element contains a comma delimited list
of all of the labels on the form.
-
The Buttons element contains a comma delimited list of the
button captions. Use "&" for the ampersand character, this
will enable the shortcut key for that key (in the example above
alt-O would be equivalent to clicking on the OK button).
-
The form title is set in the FormTitle element.
-
The values listed in the AlignValues element will appear
in the appropriate dropdown list. It will always enter
the same HTML align values into the img tag regardless of the
values entered in these elements.
View Source Form
<ViewSource>
<FormTitle>View Source</FormTitle>
<Buttons>&Apply Changes,&Cancel</Buttons>
</ViewSource>
The ViewSource node contains:
-
A FormTitle element which sets the form title.
-
A Buttons element which contains a comma delimited list of the
button captions. Use "&" for the ampersand character, this
will enable the shortcut key for that key (in the example above
alt-O would be equivalent to clicking on the OK button).
PopupFormLabels Closing
Tag
</PopupFormLabels>
The closing tag for the PopupFormLabels node
Registration
<Registration>
<Sites>http://mysite.com</Sites>
<Key>0M2AYERDWSFR2YN0W3ZK</Key>
</Registration>
The Registration node contains the sites for
which you have a license and a registration key. To use
the AdminimizerToolbar on a site its URL must be listed in
the Sites element. The registration checker strips out
"www." from all domain names so the toolbar will work on http://www.domain.com/ and
domain.com, however site1.domain.com and site2.domain.com
would require separate licenses.
For demonstration purposes, registration is not
necessary for 60 days on the Toolbar.
Blog Settings
<Blog>
<Enabled>False</Enabled>
<blogID>000000</blogID>
<XMLRPCURI>http://plant.blogger.com/api/RPC2</XMLRPCURI>
<Publish>True</Publish>
<TimeOut>30</TimeOut>
<RemoveLineBreaks>True</RemoveLineBreaks>
<API>Blogger</API>
<Categories></Categories>
<Title>
<TitleID>editTitle</TitleID>
<EditorOn>
<border>thin solid blue</border>
<background></background>
</EditorOn>
<EditorOff>
<Border></Border>
<Background></Background>
</EditorOff>
<IsLink>True</IsLink>
</Title>
</Blog>
The blog node contains your blog configuration.
-
Enabled is set to true then the toolbar will submit content
using the built in XML-RPC server instead of via HTTP post. It will
NOT use the saver.asp page if it is set to true.
-
The blog ID is the string that identifies your
blog.
-
XMLRPCURI is the URL of the XML-RPC listener. By default it is
set to use Blogger.
-
If Publish is set to true then your blog will be
published immediately upon submission, if it is set to
false you will need to go to your blog service and publish it
manually.
-
RemoveLineBreaks will remove all line breaks from your post,
which allows you to leave Convert Line Breaks set to
"yes" in your Blog settings.
-
API allows you to choose which API the toolbar will use.
Default is Blogger other choices are "metaWeblog" and "mt".
"metaWeblog" will work on Radio Userland and Movable Type, "mt"
will work only on Movable Type.
-
Categories is used only if the API is set to "metaWeblog". It
should contain a comma delimited list of your blog categories.
If you do not want to set categories, or if you have none, you
can omit this tag or leave it blank.
-
The Title node contains information about the titles of your
posts.
-
-
TitleID is analogous to the editID node, but it is reserved
for blog titles. It defaults to "editTitle"
-
EditorOn and EditorOff are used to set the border and
background colors of your posts when the editor is turned on and
when it is turned off. These can be left blank or omitted if you
like the default.
-
IsLink should be set to true if your blog service
automatically makes your blog title a permalink (like Radio). This
will prevent multiple A tags from being placed around your
title
Root Node Closing
Tag
</Settings>
The closing tag for the Settings Node and for the
document.
|
documentation
documentation
