Include Scripts
Include Scripts are dynamic pages that can be included in page content using an [[include:]] tag. Various options can be set in the include tag to modify the script's behavior. For example, [[include:_ListNav]] will display a list of links to each of the current page's children, while [[include:_ListNav root=Menu]] will display links to children of the Menu page.
For all scripts that list links, pages that are hidden, have no title, or aren't accessible to the current user will not be included.
Note: Many of these rely on style sheet changes made to skins on October 24, 2008. If you have not applied your site's ski n since that date, the output of some of these scripts may not be formatted properly. You can obtain an updated style sheet by re-applying your site's skin.
The following include scripts are currently available:
- _ListNav - Lists links to child pages of the current page, or a specified page.
- _ListRecent - Lists links to pages that have been recently changed.
- _MonthNav - Provides a date-based navigation based on Page Date values.
- _PageDate - Displays the current page date.
- _PagesByDate - Lists pages headings with or without content in a specified month.
- _SearchForm - Displays a text box to enter search keywords.
- _ShowFeed - Displays the contents of an external RSS feed.
- _TreeNav - Provides a dynamic tree navigation starting with child pages of a specified root page.
See Additional CSS Parameters for a discussion of additional CSS-based parameters supported by navigation scripts.
_ListNav
Lists links to child pages of the current page, or a specified page.
Parameters:
- root - optionally specify a parent page whose child pages should be listed. By default, the current page's children are listed.
Examples:
- [[include:_ListNav]]
- [[include:_ListNav root=Menu]]
_ListRecent
Lists links to pages that have been recently changed. Hover the mouse over a link for change details.
Parameters:
- limit - optionally specify the number of links to display; the default is 5
Examples:
- [[include:_ListRecent]]
- [[include:_ListRecent limit=10]]
_MonthNav
Provides a date-based navigation of months based on Page Date values, much like the archive links commonly seen in blogs. Links for each month representing one or more page are listed in reverse chronological order. The links go to the _PagesByDate page, which lists pages in the month clicked. By default, all pages on the site with a page date specified are included, though a more useful scenario is when a parent page is specified. This can be used to implement one or more blogs within an EditMe site.
Parameters:
- root - optionally limits the set of page dates to pages that have the specified parent.
- limit - limit the number of month/year combinations listed, by default there is no limit.
- dest - allows a page other than _PagesByDate to be linked to, useful if a custom Pages By Date script is in use
- head - a heading to display before the list of links, if there are any. This value must be URL Encoded - use %20 instead of spaces.
- conditional - causes the output to be shown only if the current page is the root page or has the root page as a parent.
Examples:
- [[include:_MonthNav]]
This will list month links for every single viewable page on the site that has a Page Date specified. - [[include:_MonthNav root=KensBlog limit=12 conditional]]
This will list month links for child pages of the KensBlog page. It will only show when the current page is KensBlog, one of the child pages of KensBlog, or _PagesByDate.
_PageDate
Outputs the current page date using an optional formatting code.
Parameters:
- [format specifier] - A single parameter for format specifier. See Date Formatting Codes for supported formatting codes. If omitted, "MMMM d, yyyy" will be used, which produces a date like October 25, 2008.
Examples:
- [[include:_PageDate]]
- [[include:_PageDate yyyy-MM-dd]]
_PagesByDate
Lists pages headings with or without content in a specified month. This script can be used to provide a blog-like listing of pages in reverse chronological order based on page date.
Parameters:
- root - Limit pages listed to children of the named page.
- month - Limit pages listed to the specified month, from 1 (January) to 12 (December).
- year - Limit pages listed to the specified year.
- content - "yes" or "no" (without quotes). If yes, page content will be included. If no, linked titles and excerpts will be shown. Default is no.
- excerpts - "yes" or "no" (without quotes). If yes, excerpts will be shown after linked titles. If no, linked titles and excerpts will be shown. Default is yes. Has no effect if content=yes.
- limit - Limit the number of pages shown.
- headings - "yes" or "no" (without quotes). If yes, month and year headings will be inserted at appropriate points in the list. Default is yes.
- replaceTitle - "yes" or "no" (without quotes). If yes, the current page's title will be replaced with either the title of the root page or the title of the first page in the list (if content=yes). Default is yes. This capability requires the site's skin to have been applied or re-applied after 10/24/2008.
- startat - The number in the list to show first. Default is 1, meaning start at the beginning.
Examples:
- [[include:_PagesByDate]]
Lists all pages with a page date specified in reverse chronological order. Linked titles are listed with excerpts. - [[include:_PagesByDate content=yes root=KensBlog limit=1]]
Displays the most recent child page of KensBlog with full content.
_SearchForm
Displays a small text box to let users search the site. Drop this anywhere in your Menu or other pages to make site search always available. This script should be included only once per page.
Parameters:
- button -By default, no button is shown and the user must use the Enter key to submit their search. Enter a value here to show a button with the specified text. Note that spaces aren't allowed, so use the + character to make a space in the value.
- size - The font size for the text box and button, as a percentage value. This value is 80 by default. To display the box and button at full size, use 100.
Examples:
- [[include:_SearchForm]]
- [[include:_SearchForm button=Site+Search size=120]]
_ShowFeed
Displays the contents of an external RSS feed.
Parameters:
- feed URL - Include the full URL of the feed you want to display. For example, to show the feed of top pages from NPR.org, it would be http://www.npr.org/rss/rss.php?id=1002
- links | full-content | excerpts - Include one of these options to specify how the feed is displayed.
- excerpts is the default (and so, optional), displaying what you see above. An excerpt of the content provided in the feed is taken and displayed under each heading.
- full-content displays the header and all of the content provided in the feed. Note that some feeds provide lots of content, others only provide a small excerpt; _ShowFeed will only show the full content of articles if they're included in the feed to begin with.
- links displays a simple bulled list of the titles linked to the stories. This is the most compact option.
- limit - By default, 4 items from the feed are shown. You can specify how many by specifying a limit. For example, limit=10 will show 10 items from the feed. Note that you can only show as many items as are actually included in the live feed.
Google Feedfetcher Key
The first time you use use _ShowFeed on your site, it will prompt you for a Google Feedfetcher API key. This sounds complicated, but it's not.
Getting an API key from Google is easy (and free):
- Go to Google's AJAX Feed API Sign-up Page.
- Agree to the Terms and Conditions by checking the box.
- Enter your site's address. This should be the address you normally use to access your EditMe site. For example, http://YOURNAME.editme.com. If you use a custom domain for your site, enter that address instead.
- You'll be asked to sign into your Google Account.
- You'll see a message reading, "Your key is:" followed by a long line of green text gobbledigook. Copy and paste that value into the box provided by _ShowFeed and submit.
_ShowFeed will give you a box to paste your key into. You'll only have to do this once. _ShowFeed will remember your key and use everywhere on your site from then on.
Examples:
- [[include:_ShowFeed http://www.npr.org/rss/rss.php?id=1002 excerpts limit=10]]
- [[include:_ShowFeed http://www.npr.org/rss/rss.php?id=1002]]
_TreeNav
Provides a dynamic tree navigation starting with child pages of a specified root page. When a top-level page is current, it is unlinked and bold and its child pages are displayed. Always shows the root page's children down to the current page and its children, if any.
Parameters:
- root - The parent page containing the top level navigation. For example, if root=Menu, the child pages of the Menu page will be listed at the top level.
- depth - Limit the depth the tree will go. For example, if you want the tree to show only the first and second level, set depth=2. Default is unlimited.
- level - Start at the specified level. This is useful if the first level of the navigation is displayed in alternative location, such as a horizontal navigation bar. If level=2, for example, output will only show if the current page is at or beneath level 2 of the hierarchy, and it will start at the second level.
- current - Allows you to over-ride what is considered to be the "current" page. By default this is the name of the current page.
Examples:
- [[include:_TreeNav root=Menu]]
This is the default tree included in the Menu page of new sites.
Additional CSS Parameters
Include scripts share a number of common parameters that allow you to control the CSS classes and IDs of the output HTML. You can customize your site's style sheet with additional styles and set alternative class names and IDs with these parameters. Most lists output content in an unordered list, which provides extensive formatting possibilities. By default, most skins display these as a simple list without bullets.
- spanid - Sets the ID attribute of the span tag encompassing output.
- Supported by: _ListNav, _ListRecent, _MonthNav, _TreeNav
- liclass - Sets the class used for LI tags in the list output.
- Supported by: _ListNav, _ListRecent, _MonthNav, _TreeNav
- selclass - Sets the class used for the LI tag in the list output that represents the current page.
- Supported by: _ListNav, _TreeNav
- expclass - Sets the class used for LI tags that contain (at any level) the current page.
- Supported by: _TreeNav
