This is the Siteframe online help system. It is not a complete reference to the system; instead, it provides a brief reference to the various settings and controls on the site.
You can access the help system wherever you see the [?] hyperlink.
[Close]
Some text entry fields support automatic formatting. Automatic formatting provides a simple way to format your text. Here are the basic rules:
Two or more newlines (carriage returns) to start a paragraph.
Hyperlinks are automatically linked; you can also use [text|URL]
to create a link with different text.
Text between double single quotes is ''emphasized'' (usually italic). Text between __double underscores__ is in bold.
An asterix (*) at the beginning of the line indicates a bulleted list. Lines that start with a (#) character are used for numbered lists.
Lines that start with a space are displayed in monospaced font.
"%%%" is a hard line break.
---- (four or more dashes) indicates a horizontal rule.
Exclamation points (!) at the beginning of a line indicate a heading. More !!! points indicate more emphasis.
Note: If you enter any HTML tags (indicated by a "<" character), then no automatic formatting is performed. In addition, certain HTML tags are not allowed in documents created on the site, and will be automatically removed if you attempt to use them.
[Close]
If you check the "remember login" checkbox, then the website will leave a cookie on your computer so that you do not have to login again the next time you visit the site. A cookie is a small bit of information that is stored on your computer, and is sent to the server by your browser the next time you visit this site. In this case, the cookie contains an encrypted string that is used to identify you to the website; no personal information is stored in the cookie.
[Close]
The document tag is a text string that may be used to identify a
document. It can only be set by a site administrator. When used, it
allows simple URLs like http://example.com/doc/treaty
instead of http://example.com/document.php?id=381,
which is not as meaningful.
[Close]
This website supports a number of different documents (though the site administrator(s) may have disabled some of them). These are some of the more comment document types:
[Close]
An e-mail address is required to log in to a Siteframe website. This e-mail address is used to uniquely identify you to the website. By default, your e-mail address will not be visible on the site (unless your site administrator has modified the software).
[Close]
You can add your document to a folder for easy organization. To be able to select a folder for your document, the folder must be either (a) owned by you, (b) public, that is, open to anyone, or (c) the folder permissions must have granted you submittor rights on it.
[Close]
If the "hidden" checkbox on a document is checked, then the document will only be visible through the user's "document" listing. The document will not appear in any other listings on the site. Hidden documents can still be viewed by site users; however, you must provide a link to the document directly.
[Close]
You can optionally provide a nickname for your user account. In some cases, the nickname will be used in place of your full name (however, this has not been completely implemented throughout the website).
[Close]
Your password authenticates you to the website. You should choose a password that you can easily remember but which would be difficult for someone else to guess.
[Close]
A rating is a score (from 1 to 10, with 10 being the best) that you give to a document. Usually, you are not permitted to rate your own documents (though this policy can be modified by the site administrator). In addition, there may be a rule in place that requires ratings below a certain level to be accompanied by a comment to justify the rating.
[Close]
The registration model determines how users can join and be authenticated to your website. The confirm model is the default; users may register and provide an e-mail address; however, that e-mail address must be verified (by having the user respond to an encoded e-mail sent to it) before the user can access the site. Unconfirmed users may be automatically deleted after a period of time.
The open model allows users to register, but their e-mail address is "trusted;" i.e., it does not have to be confirmed. This is often convenient in an intranet implementation.
Finally, the closed model does not allow any users to register; instead, they must be registered by a site administrator. This means that only selected individuals can join the site. In addition, there are other security controls in place with the closed model; no one except logged-on users can view lists of users, for example, thus ensuring privacy.
[Close]
Many document types allow you to define a document summary in addition to the main body of the document. The summary is often displayed in listings; for example, when you view a folder containing Articles, the summary will usually appear with the document's title.
The information contained in this web page is Copyright ©2003, Broadpool, LLC. All rights reserved. This information is released in accordance with the Creative Commons license contained in the file LICENSE.txt which is distributed with this software.
You can learn more about this software at http://siteframe.org