2. simpleBlog v. 0.1 beta7
Date: 12.11.2006
2.1. What does sBlog do?
sBlog is a small plugin for the Content Management System CMSimple. It runs only under the CMSimple environment. It is thought to be used as a program that generates and manages an unlimited number of WebLogs. On every CMSimple page a WebLog can be installed. Multiple functions - input fields, a captcha function, cleantext function and Email notification - can be controlled in the admin back end.
2.2. Who made the plugin?
sBlog is a modification of the gBook plugin made by Qualifire (gBook v.0.1 beta2). It was modified by NMuD. The main programm backbone together with the Javascript input function is Qualifire's work. However, we replaced the simple Captcha function with a randomizer. The cleantext function was published once by Clem Rutter in the CMSimple Forum. The automatic Email notification was published once by us in the CMSimple forum. Also a major part of the administration is our work. Since sBlog has the ability to manage multiple files, its administrator has to edit and save its contents. The major difficulty for us was to find a solution of how to keep the value of the variable which holds the particular file's name. The plugin had the habit to forget the name of the file while working on its content. Michael Svarrer programmed a routine which made the plugin to remember.
Since this plugin is made for CMSimple and runs only under CMSimple's environment, sBlog is subject to the AGPL conditions - like CMSimple itself. Informations about the AGPL-conditions can be found at http://www.cmsimple.dk/?License.
2.3. Installation
2.3.1. Where do I get sBlog from?
sBlog can be downloaded from:: http://www.nmud.de/cmsimple-templates/downloads.shtml.
2.3.2. What has to be done before sBlog is installated?
- sBlog runs only in conjunction with the content management system CMSimple. This program can be downloaded from www.cmsimple.dk and subsequently installed on an internet server. Installation instructions for CMSimple can be received from its web site.
- In addition Michael Svarrer's plugin loader has to be installed. sBlog does not run without it. The plugin loader can be downloaded from cmsimpleplugins.svarrer.dk/?Plugin_Loader. Instructions of how to install the plugin loader are shown on Michael's site as well.
2.3.3. How is sBlog installed?
- Installation on a server: After download the sBlog ZIP-file is unzipped into the folder ./cmsimple/plugins of the server. It has to be considered that the sBlog's subfolder structure is kept as it has been packed in the ZIP file. After unzipping and copying onto the server the folder structure has to look like:
+-plugins
| +-sblog
| +-config
| +-content
| +-css
| +-help
| +-images
| +-languages
Now CMSimple can be started and the administration area can be chosen. sBlog should now be visible on the list of plugins. If it is not, there went something wrong (check the folder structure !!!).
sBlog should not be renamed. It would not run.
- Rights of folders and files on Linux-servers: The folders config, content, css and languages und their files (with the exception of the files of the folder content) have to be set to CHMOD777. The files in the folder content have not to be set to CHMOD777, since they are generated by sBlog and receive their rights from the server.
2.4. Use of sBlog
2.4.1. How do I use sBlog?
sBlog can be installed on every page of CMSimple. Each installation has to be accompanied by a data file in the content subfolder. However, this file will be generated by sBlog itself with a specificly given name. To achieve this, sBlog has to be installed using CMSimple scripting the following way:
#CMSimple $output.= sblog(MyFile);#The name of the data file will be determined by the name which is set between the brackets (in this case: MyFile). Upon the first entry, which is given in using sBlog, the data file is generated. Its name is a combination of the name, which is set between the brackets, the language code (in this case "en") and the ending "txt". It will look for example like: MyFile_en.txt.
The page containing the sBlog installation script can, of course, be filled with text and images.
Info:
1. It has been reported and approved by us, that sBlog data are not shown, if the name of a file (MyFile) starts with a number as in #CMSimple $output.= sblog(1st_day_of_vacation);#.
2. It has been reported but not approved by us, that instead using a name also the CMSimple variable $su can be used as in #CMSimple $output.= sblog($su);#. In this case the page title will automatically be used as name. Here also numbers will work in first position of the name.
2.4.2. Does sBlog have multiple language support?
sBlog supports different languages. Specific settings are not required. sBlog will recognize the language which is set via administration of CMSimple. However, the required language packages have to be present. So far, the following language packs are available:
1. German
2. English
3. French (translation: Gerd Xhonneux)
4. Norwegian (translation: Børge Nilssen)
5. Danish (translation: Preben Kittelmann)
2.4.3. How stable does sBlog run?
Up to now, no serious blue screen has been observed :-). sBlog runs in combination with gBook (Qualifire), Gallery and Calendar (Svarrer), genizeBblog (Geniz) und MenuManager (2bdesign). There are problems with the preliminary version of the plugin CMRFC_beta05 of Clem Rutter. Proper rendering fails as soon as a new entry is saved. The web site call has to be renewed. However, saving of the new entry works. Other plugins still have to be tested.
2.5. Administration of sBlog
The administration level of sBlog can be reached in CMSimple's admin area over "Select Plugin -> Sblog". Upon opening of a menu there will be visible five options: Edit file, Stylesheet, Configuration, Language and Help.
2.5.1. Edit files / Delete files
Upon opening Edit file two select boxes and an empty editor window will appear. A click on the select boxes will show all available data files which have been generated by sBlog. Selection of one file of the left box will load this file into the editor window. After editing, clicking the "Save" button will save the changed file.
Records which are shown in the editor window consist of eight data fields.
- Name
- Email-address
- Web site address
- Time
- Date
- Web address of an image file
- Text-entry
- IP of the visitor
Each data field is separated by a semicolon. Therefore, semicolons which are entered by a visitor are changed to commas. The record is closed by the notice: [END OF RECORD]. (Just for better overview).
Warning: Selecting one file of the right box will delete this file irrevocably !!!!
2.5.2. Stylesheet
The option Stylesheet allows changes on the appearance of sBlog inside of a CMSimple page. It should be realized that changing anything may generate unintended results. Changes have to be saved using the "Save" button.
2.5.3. Configuration
Selection of Configuration allows changes of 12 options:
1. date format: | allows changing the appearence of the date. |
2. time format: | allows changing the appearence of the time. |
3. chronological order: | true/false - toggle for the chronological order of the messages. Reverse chronological order (false) means: newest message on top, oldest message at the bottom. "True" means: vice versa. |
4. simpleCaptcha: | true/false - toggle for using the captcha-function. |
5. record Release: | true/false - setting on true requires approval of a new record by the moderator for publishing. |
6. email: | true/false - toggle for the input field of the visitor's Email-address. |
7. website: | true/false - toggle for the input field of the visitor's web site-address. |
8. cleanText: | true/false - toggle for using the cleantext-function. |
9. emailNoticeTo: | Entry of an Email address informs the owner of this address about a new blog entry. |
10. image: | true/false - toggle for entry of the web address of an image. |
11. max height: | maximal height of the image in pixels. (allow_url_fopen must be "on") |
12. max width: | maximal width of the image in pixels. (allow_url_fopen must be "on") |
Four important notices:
- If record_release is set on true, the input of a visitor is saved but not shown. Before the user saves he sees an alert, which tells him that the new record needs approval. The new record is saved with two hashes (##) in front of the first field which represents the name, as it is indicated in "##John Doe; etc .......". The output is filtered and every record starting with two hashes is kicked out for the viewer.
The moderator edits the particular file and removes the two hashes to make the record visible for the visitor. He also can hide older records by adding two hashes.
While the hashes are written to the data file only if "record_release" is set on true, the output filter is also active, if "record_release" is set on false (or left empty). So just deactivating the record_release option does not make the records visible, which are flagged with hashes. To make them visible, the hashes always have to be removed. The advantage is: the moderator can switch off the record_release option for a short period of time without having to show the flagged records. Second, people who have set the option on off can still use the filtering function manually by just adding hashes using the editor.
- The cleantext-function removes troublesome HTML and Javascript code. However, this does not mean, that sBlog is bomb-proof. Hackers will still find ways which enable adding unwanted code.
- The emailNoticeTo-function will not only inform the email address owner about a new entry but will also inform about the location of the entry. This will make it easier for the admin to find a record to edit if more than one blog is set up.
- The image function offers the possibility to configure the maximal width and/or height of every image shown (in pixels). The respective value will be considered. This prevents deterioration of the web site's layout in case an image is to large. However, such an image can be viewed in its original size in a separate window by clicking on it. (To realize the extra-window function the Javascript code of Michael Svarrer's gallery plugin has been used.)
This function is only activ, if PHP on your Server is configured with allow_url_fopen = on. If it is configured as allow_url_fopen = off, images are shown in their original size. However, images too large may destroy the web page layout. To circumvent this a change in the sBlog CSS will help. You may change "img.sBlogImage { border: none; }" to "img.sBlogImage { border: none; max-width:XYpx; max-height:XYpx; }". This will even work in the Internet Explorer, because the Javascript file "minmax.js" will support the IE to understand these CSS2 properties. However, if Javascript is inactivated, it will not work in the IE while in other modern browsers it still does.
2.5.4. Language
Selection of Language allows to change the commentary words which are popping up during sBlog usage. This is possible in all available languges.
2.5.5. Help
Help calls up this Web Site.
2.6. Disclaimer
There is no warrenty using this plugin. It will be used on everybody's own risk. We will not assume any liability in case of data losses caused by sBlog usage.