All the variables that are available to you when you create your guestbook page are described below.
| $bookID |
Your user ID |
| $bookIDEnc |
Your user ID converted as URL compliant string. e.g. $bookID = 'te st' ==> $bookIDEnc = 'te+st' |
| $pageURL |
The URL to your main page |
| $writeAdd |
The URL to the 'Sign the Guestbook' -page |
| $CALL_LOCATION |
The path (URL) to the read- and sign pages. It is adviced for you to use this variable instead of the real address, as the real address may change (doubtful, but it may happen). If the real address changes, this variable will change accordingly and you don't have to update your HTML code. At the moment this address is 'http://www.freebok.net/books' |
| $ip |
IP address of the visitor |
| $add1 |
Free variable. You may use this variable for your own purposes. For example, you can use it to implement a multilingual guestbook ( i ). Please note that the free variables are shown in the guestbook URL address, so it is advised not to use them to transfer any sensitive information. |
| $add2 |
Free variable. |
| $msgPerPage |
Messages / page |
| $msgTotal |
Total number of messages in your guestbook |
| $msgStart |
The message number of the first message in the current page |
| $msgEnd |
The message number of the last message in the current page |
| $page |
The page number of the current page |
| $nextPage |
The next page number. Points to the beginning of the guestbook. If $page == 2 => $nextPage == 1. If current page ($page) is the first page ('1') $next page = '' (empty value). |
| $prevPage |
The previous page number. Points to the end of the guestbook. |
| $firstPage |
Page number of the first page of the guestbook. |
| $lastPage |
The number of the last page of the guestbook. |
| $messages |
Array of messages. The single most important variable. Includes a list of all the messages in current page. This array can be printed using the #foreach directive as described in the Velocity guide. The $messages variable contains these properties:
| name |
Message writer's name |
| email |
Email address |
| city |
City |
| hpName |
Homepage name |
| hpURL |
Homepage address |
| text1 |
Free text field 1 |
| text2 |
Free text field 2 |
| text3 |
Free text field 3 |
| selection1 |
Free selection field 1 |
| selection2 |
Free selection field 2 |
| message |
Message |
| date |
Message date |
| answer |
Your reply (if any) |
| ip |
Sender IP address |
| domain |
Sender domain name (only for Freebok supporters) |
|