BoltWire

Radical Ideas :: Radical Results!


login | register | print

Glossary of Terms

Documentation > Glossary of Terms

This page is a basic glossary for BoltWire. Some words are generic to wiki's, others more specific to this software. If you encounter some term in the documentation that is unclear to you, send an email to the BoltWire mailing list and we'll try and add a definition here for the next release.

WIKI TERMS
Wiki: A kind of web management system using markup to simplify web editing, and allowing for collaborative authoring of websites.

Farm: An installation of one or more fields (websites) maintained by one barn (code base). Normally farm fields are all found in a single farm folder (called "boltwire"), but they can be located elsewhere.

Barn: The folder containing the BoltWire code base. Think of the scripts in the barn as a tractor with its various implements. The tractor can work multiple fields as long as they are all in the same farm. A pages folder is also located within the barn folder containing all the default BoltWire system pages.

Field: Each website using the BoltWire code base, is called a field. Each field has its own folder (normally inside the farm folder), with its own pages, files, and tools. An installation of several fields is called a farm.

Page: A specific page in your site. Each is an individual file, with a lower case name containing several parts joined by dots. They are normally stored in a field's "pages" folder and are also called field pages. System pages are found inside the barn's pages folder, and are used for the site's default setup.

Sandbox: A special page where you can practice using wiki markup and not mess up other parts of the site.

EXTENSION TERMS
Extensions: Any customization added to BoltWire to make it more useful or effective. There are five kinds of extensions in BoltWire (also called tools), including: markups, variables, functions, conditions, and commands. Extensions are also called tools.

Markup: Simple code you enter into a page that is transformed by the wiki engine into more complete html.

Variables: Special values that can be retrieved into a page dynamically. There are several kinds of BoltWire variables including config variables (controlling site configuration), system variables (available on every page as {field}), data variables (drawn from the data section of a given page), and text variables (extracted from the actual text of a page.

Functions: These refer to specific markups of the form [(function parameters)] which generate various kinds of output automatically. Generally php functions are referred to as php functions or code functions.

Conditions: Various checks that can be performed in a page to control what is or is not displayed, such as [if login]You are logged in[else]You are not logged in[if].

Commands: These are special form fields that trigger interactive effects in BoltWire. These can be combined to make your own custom forms or actions.

Actions: Special pages that produce system actions. These are defined by regular pages with names like action.edit or action.source. They can be easily created, modified, or disabled.

MISCELLANEOUS TERMS
Member: A user who has created an account and logged in. {member} will reveal his member name, while {id} will reveal his member id.

Groups: Sometimes referred to as member or user groups (as opposed to page groups). Groups are defined by pages containing simple lists of members, found in locations such as group.chessclub.

Admin: A special user group, with extensive, but limitable authority in your wiki. Generally able to edit code pages and create forms. A "BOLTadmin" is a special user account, normally defined in your field index page with unlimited authority in your wiki.

Editor: A special user group, similar to admins, but restricted from certain pages and actions. Generally able to edit code pages and create forms.

Skin: BoltWire is fully skinnable, allowing you to separate format from content. Think of a skin as the basic html framework used to display your page. You can easily customize the skin of any page or group of pages in your site.

Icon: It is easy to add images to your Boltwire installation by simply adding them to the farm's icons directory. Icon's become instantly available to your site and/or skins. The BoltWire resource pack comes a large number of icons.

Zones: Various defined sections of your skin that look for and pull in other pages to produce things like a sidebar, a header, a style sheet, or something else. You can have as many zones of any kind as you like.

Hierarchy: BoltWire is fully hierarchical, meaning attributes of parent pages are passed down to child pages. Understanding hierarchies in BoltWire makes site administration much easier.

Parent/Child Pages: A page like test.one is a child of test, while test is a parent of test.one. You can also have uncle, cousin, nephew, and grandchild pages, etc. Sometimes these are call ancestor/descendent pages.

LINK TERMS
Interwiki: Interwiki's are special shortcut links to other wiki's or websites. By default, BoltWire has interwiki entries for Wikipedia and BoltWire on page site.interwiki.

Hotlinks: Hotlinks allow you to turn certain key words into automatically generated links to specific pages. BoltWire uses hotlinks, defined on site.hotlinks, to create a kind of glossary. By default, they look appear as slightly grayed out words with dotted underlines.

Trails: Trails allow you to define certain groups of pages into a set of PREV | NEXT links. They can be pages in the same group, from different areas, or generated dynamically.

Breadcrumb: Breadcrumbs are a row of special links related to your current pages location in the hierarchy, looking something like Kingdom > Animal > Dog.

Tags: Tags enable you to associate pages with certain key words, and then retrieve a list of all pages tagged with those words.

Missing: Links to pages that do not exist are identified by a small red question mark. If authorized, you can simply click the link to create the page.

CONFIGURATION TERMS
Toolbox: This is a special directory in your field folder that can contain config files with custom config settings and/or custom tools (extensions). You can also completely replace existing BoltWire toolsets, skins, and/or plugins.

Tool: An extension to BoltWire's default markups, variables, functions, conditions, and/or commands. They are normally stored in a config page in your field's toolbox. Most barn scripts (like commands.php & functions.php) can be replaced sitewide or for specific groups or pages by creating customized local copies in your toolbox as well.

Plugin: A ready-to-install backup file and/or php file used to create a special effect (like a shopping cart, email/newsletter, or chat plugin). Several come pre-bundled in the BoltWire resource pack, and can be easily added to the farm's plugin folder.

Site Config: A special page with the wiki itself with various setting and options for how BoltWire works. It is easy to modify how BoltWire works--just make sure you know what you are doing!

Config Page: A php file in the toolbox (containing tools) keyed to a certain page in the hierarchy, such as config.forum.php, which applies to pages in the forum group, and all child pages. Settings in config.php apply sitewide.

Index Page: A special config page located in the field directory (named index.php) that can also be used to set certain config variables. This is the page actually called in your URL that calls the BoltWire engine.


WWW.BOLTWIRE.COMlogin | register | print
This page was created on 04/25/24 15:07:35. Copyright © 2008, all rights reserved.