BEE Script:   text name [default=string]
[editprompt=string] [init=string]
[webpath=string] [textpath=string]
[display=bool] [showvar=bool]
[edit=bool] [anchor=string]
[highlight=var] [hlbegin=string] [hlend=string];  

BEE Tag:     <beetext name [default=string]
[editprompt=string] [init=string]
[webpath=string] [textpath=string]
[display=bool] [showvar=bool]
[edit=bool] [anchor=string]
[highlight=var] [hlbegin=string] [hlend=string]>

The Text Command is used to specify a unit of content that can be displayed, searched.  If the "admin" user is logged in, the text can be edited.  In such case, at the end of each text unit there is a link to a Text Edit page, which allows modification of the text content via a word processor-like interface.

The textName is a "Text Variable" in the format of "page&text:item".  The "page" part is default to be the path of the caller page's URL ({sys%urlshown:pathpage}).  For example, If the "text" command is called from "http://www.foo.com/blah/mypage.htm?abc=1", the default "page" part will be "/blah/mypage.htm".)   The "text" part is the name of the text unit and should be unique within the page.  The "item" part is optional.  If used, it helps to group different text units under the same name for clarity.

The value of the text variable is stored with the web site as part of the content.  It can be accessed via the "text" class: "text%page&text:item" (internally implemented as a "scheme" class object).  Since "page" is default to the current page, you can take it that every page has a "text" class of its own (i.e. text%text:item refers to text%CurrentPage&text:item).  The "page&" part is used only if you want to refer to the "text" class of another page.

The "item" part is rarely used.  However, one special item called "AllowView", which will let you specify an access level below which the text is not visible.  For example, if you specify "text%member.htm&sensitive:AllowView" to "member", any sessions with a privilege under that of "member" will not see the text.  (AllowView defaults to "public".)  There are another special item called "AllowEdit" which control the editing of page text.  More details can be found later in this section.

Parameter

default specifies the string to display if the text content is blank.

editprompt specifies the string to display in the text editor if the text content is blank.

init specifies the string to display and save automatically if the text content is blank.  Upon encountering of a "text" command with the "init" parameter, the text content is created and contains the value of the "init" parameter (unlike "default" which does not create any content unless the administrator explicitly click the Edit icon, enter the new text and Save.)

The "init" parameter is usually used to convert an existing page into a template without affecting the appearance.  You just surround the original text with <beetext textName init='originalText'> and after the first run of that page, the content is saved.  (The "init" value has no effect in subsequent runs and therefore can be removed.)

webpath is for "non-standard" text storage structure.  For example, if your web site's home path is http://server/mysite, so for page http://server/mysite/mypage.htm you naturally want its content to be stored under text%/mypage.htm&.  However, according to the "standard" text storage structure, the content should be in text%/mysite/mypage.htm.  To breach the two structures, you can specify webpath=/mysite and the "text" command will work out that the text file is in fact in text%/mypage.htm& (instead of text%/mysite/mypage.htm&).

textpath is for "non-standard" text storage structure.  For example, if for some reasons your want to "bury" your content under a subdirectory (usually for version control), you can specify textpath=/subdir and the "text" command will use text%/subdir/mypage.htm& (instead of text%/mypage.htm&) for the content of http://server/mypage.htm.

display indicates whether to display the text unit or not.  The default is true.  The usual case to turn "display" off is to include a server-side hidden text in the page so that the browser at the client-side cannot see, not even with "View Source".  For example, if a product information page shows pricing that is derived from a cost figure that you set in the page, you would not want the customer to see the cost.  You can use the Text Command with display=false so only the admin login will see it.

showvar indicates whether to evaluate for BEE values before displaying the string.  This does not affect the text in edit, which is always showing the text without evaluation so that the user can modify the expression.  The default is false.

edit indicates whether to allow edit on this text unit or not.  Even when "edit" is true, you still need to login as the "admin" user in order to be able to edit the text unit.  If "edit" is false, the text is not editable in any circumstances.

This parameter can be used to turn off the edit feature for the text unit, or to specify a "duplicated" text unit of which the value will inherit from another editable text unit of the same name.  The default is true.

anchor if specified indicates the name of the HTML anchor tag (e.g. <a name=...></a>) for direct reference/link to the text position.  You can turn anchor off by specifying anchor="".  If the "anchor" parameter is not specified and the "edit" parameter is true, then the system will use the "text" part of the textName as the anchor's name (or if the item part is specified, an underscore followed by the item name will be appended to the anchor's name to make it unique.)

highlight is the name of the variable that contains the string to highlight (usually as a result of a search).  If the variable is an array, every strings in the array will be highlighted.

hlbegin specifies the string displayed before the highlighted text.  The default is "<strong>".

hlend specifies the string displayed after the highlighted text.  The default is "</strong>".

There are some special "text" and "scheme" class variables to govern the user privileges of text viewing and editing:

There are some "scheme" class variables to control the text viewing and editing functions:

There are some special "session" and "scheme" class variables to govern the image and file insertion:

After calling the function, the following BEE Variables are made available: