Node Package: Global Web Settings

The web/settings node contains a number of parameters that may affect the entire web site. The webdestination (wpWebDestination) node contains FTP username, password and other parameters telling WebPal how to access your hosting server for publishing. Add other parameters such as author, copyright, keywords, title and description to set global meta information and increase usability. To track your stats you can now add Google Analytics code to the settings node.

wpWebsettings

Within the settings node you may define some specific settings related to your web site, such as a destination web host.

Where to use this node

wpWeb
- settings (wpWebsettings)
  - file-prefix (wpRaw)
  - phrase (wpWebPhrase)
  - link (wpExternalResourceLink)
  - script (wpExternalResourceScript)

Attributes

Name	Use	Value	Help
groupaccess	default	all:r	See Access & Permission Control
useraccess	optional		See Access & Permission Control
optimize-images	oneof	auto, speed, quality	Optimizes the site and design graphics for either speed (JPG images) or quality (PNG images). "Auto" will determine for each image type what the best option is.
include-method	oneof	auto, php, SSI	Based on the server settings, will use either PHP include statements of server-side-includes to render the layout header and footer of pages.
default-file-ext	oneof	.html, .php	Determines the file extension of all non-scripted pages. Default=.html
default-script-ext	oneof	.php, .html	Determines the file extension of all scripted pages. Default=.php.
use-fast-build	oneof	yes, no	Only Preview/Publish list items that have been changed, currently available for the newslist and the stafflist

Sub Nodes

Name	Type	Help
webdestination	wpWebdestination	Contains all necessary parameters to publish your site on the live hosting server(s).
web-phrases	wpWebPhrases	Contains translations of global phrases such as "click here to continue"
dbconnector	wpDatabaseConnector	Contains all parameters to connect to the local database
title	wpStringL	The title of the web site, such as "Online Semantic Web Content Management Systems"
shorttitle	wpStringL	A short form of the web site title, such as "Online Web-CMS"
author	wpString	Sets the META element "Author". The author of the web site, such as "ACME Incorporated"
classification	wpStringL	Sets the META element "Classification". The web site category, such as "commercial web site", or "personal home page".
description	wpStringL	Sets the META element "Description". Typically a plain English description of the site, describing what it is about.
keywords	wpStringL	Sets the META element "Keywords". A comma-separated list of keywords relevant for the site.
lang	wpString	Determines language support. A bi-lingual site will contain two nodes, Eg. lang="en" and lang="fr".
analytics	wpRaw	This is where you can add Google Analytics tracking code.
rss-image	wpImage	Adds image to RSS Feeds
external-resources	wpExternalResources	Add your own external stylesheet and client scriping files.

wpWebdestination

The web destination is used to define the FTP information for the hosting environment where the site will be stored.

Where to use this node

wpWebsettings
- webdestination (wpWebdestination)

Attributes

Name	Use	Value	Help
hostname	required		FTP server name. In most cases something like: "ftp.yourdomain.com"
htmlroot	optional		The root of your web site. Example "http://www.yourdomain.com".
login	required		The FTP username.
password	password		The FTP password. For security reasons, this can be set only once. To change it, delete the webdestination, and re-create with a new password.
destdir	required		The directory in which your web site is located on the server. Eg. "public_html" or "httpdocs".
localdir	oneof	web, wap	This is usually forced to "web" - don't change.
default-file-perms	oneof	644, 755	UNIX-style permissions given to all files. In some cases, 755 (allow-write) is necessary, depending on server settings.
host-email	optional		Email address notifications regarding the hosting server will be sent to. If unsure, leave blank.
active	oneof	yes, no	Has no effect - always set to "yes".
supports-php	oneof	no, yes	Denotes if the hosting server supports PHP scripting.

Sub Nodes

Name	Type	Help
file-prefix	wpRaw	Add this node to specify code to be included at top of each generated page. This allows session tracking, etc.

wpWebPhrases

Web phrases are a local dictionary of commonly used translations for key expressions in the site, for example "click here to continue" or "return to previous". You can specify translations for all phrases generated by the system.

To populate with our default translations, download the sample code below and paste into your web/settings node.

Where to use this node

wpWebsettings
- web-phrases (wpWebPhrases)

Sub Nodes

Name	Type	Help
phrase	wpWebPhrase	See wpWebPhrase

Sample

example_web_phrases

<web-phrases   ><phrase webpalopen="closed"  value="Email to a Colleague"  name="emailtofriend"  lang="en"></phrase><phrase webpalopen="closed"  value="An einen Freund schicken"  name="emailtofriend"  lang="de"></phrase><phrase webpalopen="closed"  value="Printer-friendly version"  name="printerfriendly"  lang="en"></phrase><phrase  value="Drucker-freundliche Version"  name="printerfriendly"  lang="de"></phrase></web-phrases>

wpWebPhrase

The individual phrases inside the wpWebPhrases node.

Where to use this node

wpWebPhrases
- phrase (wpWebPhrase)

Attributes

Name	Use	Value	Help
name	oneof	emailtofriend, printerfriendly	Selects the phrase to be translated.
lang	oneof	any, en, fr, de, es	Determines which language this phrase is in.
value	optional		Enter the actual translation here. Example (lang=de): "An einen Freund schicken"

Sample

<phrase  value="Envoyer &#224; un ami"  name="emailtofriend"  lang="fr"></phrase>

wpDatabaseConnector

The connection settings for a mySQL database connection. When including this node a php file is created in the _db directory. The file is called dbopen.inc.php. This file is required for the following nodes:

Online Survey

Blog

Webform (if using the save-to-database Action)

Where to use this node

wpWebsettings
- dbconnector (wpDatabaseConnector)

Attributes

Name	Use	Value	Help
db-host	default	localhost	Specify the hostname or IP address of the DB host. If unsure, use "localhost".
db-name	required		The database name. Typically, this is the same as the site name.
db-user	required		Username for the database login as set by your hosting administrator.
db-password	password		Password for the database connection.
db-type	oneof	MySQL, other	Currently only mySQL is supported
table-prefix	optional		DEPRECATED - Prefix for all DB tables, e.g. "site_".
test-db	oneof	yes, no	DEPRECATED

Sample

<dbconnector db-type="MySQL"  db-host="localhost" test-db="yes"  db-name="tester_db" db-password="JP145@_test"  db-user="joe_tester"></dbconnector>

wpMetaTag

Add your own META element to all pages. Eg. Name = "robots" Content= "noindex".

Where to use this node

wpWebsettings
- custom-meta-tag (wpMetaTag)

Attributes

Name	Use	Value	Help
lang	oneof	any, en, fr, de, es	Determines which language this phrase is in.
name	required		Enter the name of the META element. Eg. "Robots"
content	required		Enter the content for the META element. Eg. "NOINDEX"
include-in	oneof	all-chapters, top-level-chapters, specific-chapters	Determines which chapter(s) will include this meta tag
specific-chapters	optional		Works with the include-in attribute if the specific-chapter option is selected. Here is where you like the specifc chapter's name coma seperated.

Sample

<custom-meta-tag  content="NOINDEX"  name="ROBOTS" ></custom-meta-tag>

wpGoogleAnalytics

Adding Google Analytics to your website will allow you to track visitor history, bounce rates and search engine traffic among other things.

WebPal now integrates fully with Analytics by providing users with an "Analytics" node which can be inserted into the web settings. All you have to do is get the code snippet from your Analytics account and insert it into this node.

In conjunction with this, every chapter will automatically have an analytics node added to it by default, denoting that this page should be tracked.

Where to use this node

wpChapter
- analytics (wpGoogleAnalytics)

Attributes

Name	Use	Value	Help
enabled	oneof	yes, no	Determines if the Google Analytics code will be added to that page.

Sample

<analytics    lang="any">Code Snippet Here</analytics>

wpExternalResources

This node is used to define other external resources for your entire web site, sections, or sepcific chapters of the site. You can use this node to set RSS feeds as "alternate" resources, or custom external javascript files.

Insert this node as external-resources in the web->settings node.

For example, use a link node to set an RSS feed for your site, and browsers will automatically show the RSS symbol as an alternate way to get updates from your site. Use the code example below to get started.

Where to use this node

wpWebsettings
- external-resources (wpExternalResources)

Sub Nodes

Name	Type	Help
link	wpExternalResourceLink	Defines a <link> tag creating relationship between a document and an external resource (usually used to link style sheets).
script	wpExternalResourceScript	Defines a client-side script.

Sample

<external-resources webpalopen="open" webpalschematype="wpExternalResources" modified="20101210.152917" perms="rw" modifiedBy="root"><link reverse-relationship="none" specific-chapters="" title="RSS" target="_blank" webpalschematype="wpExternalResourceLink" relationship="alternate" type="application/rss+xml" modified="20101210.152604" perms="rw" include-in="all-chapters" media="screen" modifiedBy="root" lang="any">http://twitter.com/statuses/user_timeline/77360958.rss</link><script character-encoding="" specific-chapters="" webpalschematype="wpExternalResourceScript" type="text/javascript" modified="20101210.152917" perms="rw" include-in="all-chapters" modifiedBy="root" lang="any">http://www.palominosys.com/_javascript/webpal_helpers.js</script></external-resources>

wpExternalResourceLink

Inherits from:

Where to use this node

wpExternalResources
- link (wpExternalResourceLink)

Attributes

Name	Use	Value	Help
lang	oneof	any, en, fr, de, es	Determines which language this phrase is in.
title	optional		Specifies the title of that external link.
type	optional		Specifies the MIME type of the linked document
relationship	oneof	none, alternate, appendix, bookmark, chapter, contents, copyright, glossary, help, home, index, next, prev, section, start, stylesheet, subsection	Specifies the relationship between the current document and the linked document.
reverse-relationship	oneof	none, alternate, appendix, bookmark, chapter, contents, copyright, glossary, help, home, index, next, prev, section, start, stylesheet, subsection	Specifies the relationship between the linked document and the current document.
media	oneof	screen, tty, tv, projection, handheld, print, braille, aural, all	Specifies on what device the linked document will be displayed
include-in	oneof	all-chapters, top-level-chapters, specific-chapters	Determines which chapter(s) will include this external resource
specific-chapters	optional		Works with the include-in attribute if the specific-chapter option is selected. Here is where you like the specifc chapter's name coma seperated.

Sample

<link reverse-relationship="none" specific-chapters="" title="RSS" target="_blank" webpalschematype="wpExternalResourceLink" relationship="alternate" type="application/rss+xml" modified="20101210.152604" perms="rw" include-in="all-chapters" media="screen" modifiedBy="root" lang="any">http://twitter.com/statuses/user_timeline/77360958.rss</link>

wpExternalResourceScript

Inherits from:

Where to use this node

wpExternalResources
- script (wpExternalResourceScript)

Attributes

Name	Use	Value	Help
lang	oneof	any, en, fr, de, es	Determines which language this phrase is in.
type	optional		Specifies the MIME type of a script
character-encoding	optional		Specifies the character encoding used in an external script file (optional).
include-in	oneof	all-chapters, top-level-chapters, specific-chapters	Determines which chapter(s) will include this external resource
specific-chapters	optional		Works with the include-in attribute if the specific-chapter option is selected. Here is where you like the specifc chapter's name coma seperated.

Sample

<script character-encoding="" specific-chapters="" webpalschematype="wpExternalResourceScript" type="text/javascript" modified="20101210.152917" perms="rw" include-in="all-chapters" modifiedBy="root" lang="any">http://www.palominosys.com/_javascript/webpal_helpers.js</script>

Node Package: Global Web Settings

wpWebsettings

Where to use this node

Attributes

Sub Nodes

wpWebdestination

Where to use this node

Attributes

Sub Nodes

wpWebPhrases

Where to use this node

Sub Nodes

Sample

example_web_phrases

wpWebPhrase

Where to use this node

Attributes

Sample

wpDatabaseConnector

Where to use this node

Attributes

Sample

wpMetaTag

Where to use this node

Attributes

Sample

wpGoogleAnalytics

Where to use this node

Attributes

Sample

wpExternalResources

Where to use this node

Sub Nodes

Sample

wpExternalResourceLink

Inherits from:

Where to use this node

Attributes

Sample

wpExternalResourceScript

Inherits from:

Where to use this node

Attributes

Sample

More Information

Quick Navigation