w3easyCMS Documentation

w3easyCMS version 0.07

Welcome brave one.
With this documentation you should get all the informations you need to install and run the w3easyCMS. Hopefully...

Note: This manual is still in progress...

 

Requirements

PHP 5
NO DATABASE required

 

License

The w3easyCMS and also the w3easyTools are licensed under the General Public License, version 3 (GPL 3).

This means i.a.: We give no warranties at all, whatever you might do or not do with the scripts, applications or tools or in which way ever you might use or not use them. Whatever you do with the w3easyCMS and the w3easyTools, you do it absolutely, totally and completely on your own risk!

Note, that the integrated or recommended external applications, tools or scripts might be covered by other licenses than the GPL 3.

 

Main Features

The main features of the w3easyCMS are the following:

Frontend

Template variants (integrated in the common template)
Top- or Sidebar Navigation Menu, integrated
News Module, dynamically and / or statically displayed (w3easyNews, integrated)
Comment Module (integrated)
Contact Module (integrated, preinstalled in the 'contact.php' file)
Alternative Design (integration prepared)

Image Gallery 'Galleria' (extern, basic functions in the '/engine/multimedia/galleria.php' file and integration prepared in the '.../prototypes/type-multimedia.php' file)
Music Player 'EMFF Player' (extern, integration prepared)
Video Player 'Flowplayer' (extern, integration prepared)
Lightbox2 (extern, integration prepared)
Header as Image Gallery (integration prepared)

Social Sharing Button ('Share' resp. 'iBeginShare', integrated)
Last Edit Display (integrated)
Breadcrumb Display (integrated)

Backend, Administration (incl. w3easyTools)

w3easyEditor - editor and basic file and folder manager
w3easyAdmin - editor and basic file and folder manager, incl. extern wysiwyg editor (CKEditor, integration prepared), extern web file manager for images and media files (KCFinder, integration prepared), extern ftp manager (PHFTP, integration prepared) and some more toys.
w3easyNewPage (w3easyTool to create new pages)
Backup Module (standalone w3easyBackup tool and integrated in the w3easyAdmin, mainly based on external scripts and classes)
Upload Manager (integrated in the w3easyEditor and in the w3easyAdmin)
Extern Upload Manager (KCFinder, external application, integration prepared)
FTP Manager (PHFTP, external ftp manager, integration prepared)
Directory Protection Script (w3easyProtect)
News Script - creating and administration (w3easyNews)
Text Encryption tool ('Javascrypt', external script, integrated)
Logfiles (w3easyLogs, integrated)
PHP Web Stats (extern, integration prepared)
w3easyToolbox, a 'box' to keep the tools and modules in one place

 

System Folder Structure and Important Files

First let's have a look at the folder structure and some important system files:

/ (root)

/content/
     .htaccess
/content/data/
     navilinks.inc.txt

/content/data/news/ (news module files)

/content/main/
     MAIN.inc.php
     design_change.php
/content/main/files_inc/

/content/pages/
     page-content-files.inc.txt...
     .....
/content/page-settings/
     page-settings-files.php...
     .....

/css-js/

/modules.../ (integrated external modules)
...

/templates/
/templates/template_xyz/
/templates/frames

/upload/
/upload/images/
...

/w3e/
     .htaccess

/w3e/admin/
/w3e/admin/w3easyTools.../
...
/w3e/admin/w3easyAdmin/
/w3e/admin/w3easyAdmin/modules/

...

/w3e/backup/

/w3e/engine/
     config.php
     engine.php
     functions.php
/w3e/engine/multimedia/
     mm-engine_files.php
     .....

/w3e/prototypes/
     prototype_files.php
     .....

red = important, care about at once after installation
blue or fat = You will often use it
green = contains code - use with care
orange = Never ever even think about touching it...

 

Basic File Interaction

Accessing a page starts by calling any "regular" file in the root folder or in any public subfolder you have created, f.e. '/index.php'. This file stands for a common, regular file, although in fact it consists of a php inclusion order only, that cares for the inclusion of the 'page-settings' file in the '/content/page-settings/' folder. Although the regular file is that poor, please note, that nevertheless it always defines the position in the file system and this is indeed it's main purpose.

The included '/content/page-settings/' files provide file name, page title, page name, the individual page settings and the page's meta tags. Here you can also overwrite some main settings and replace them with specifig page settings (if allowed in the main configuration) and you can also adjust the layout, if needed.
Furthermore this kind of files contains some code lines, that define the position of the file in relation to the file system (this is quite important concerning internal links, see '$path') and it loads the main php functions. In fact a 'page-settings' file has nearly everyting an adult file needs. It is like a wonder..;)
The file is even prepared to have content added in it's HEREDOC section in the lower part of the file, but we do not recommend to add content here regularly - there are more convenient ways to do it...., but note, that you should never edit it in no case with a wysiwyg editor, because of there is a lot of code on the page that would get ruined for sure and at once...
Last but not least the 'page-settings' file includes the main configuration file.

The main config file provides the main configuration settings (surprisingly..;), loads the cms engine with a major part of the core cms functionality and finally loads the respective template.

The engine provides core functionalities like session and cookie handling, it compares the main vs. the individual configuration settings and decides, what to do, it handles the integration of the content files and is responsible for the 'one-click' integration of a major part of the predefined resp. preinstalled modules like the navigation, the comment function, news module, logfiles and also the integration of some basic external modules like lightbox2, iBeginShare or the php web stats.

The template file provides the html structure of the w3easyCMS. Moreover it includes the stylesheets, the main and the individual content files, that are huddled together in the /content/pages/ folder waiting for their coming out.

 

Content Files

A page may consists of common content elements like header, logo, navigation, bottom line etc. and of individual content elements like text or images.

The common content of a page you may put in the '/content/main/' files. In fact the common main content like header, top and bottom container and the navigation container is build in the file '/content/main/MAIN.inc.php' (see below in the 'Advanced section'). Note, that it is a file containing lots of code, so you may not use the wysiwyg function to edit the file.
In fact the files in the '/content/main/files_inc/' folder are for now no longer used, but I decided to keep them. One never knows...

The individual content of your pages you build up in the '/content/pages/' files. It are by default .txt files, but the wysiwyg editor will handle them as if they were .html files. Regularly you need at least 1 file to build up individual content in the main area of your page, but you can also put individual content to the sidebars.
But what, if you want to have common content in the middle of the content of all pages, f.e. an advertisement banner?
To handle this, you have the chance to set up 2 more individual middle area content files and 1 more individual content file in each sidebar, that will be included in the output file below their respective predecessors.

To have a look of the content files arrangement, see the list below (Note, that the common content files are located in the '/content/main/files_inc/' folder:

Overview about the included content files

left.txt (common content) middle.txt (common content) right.txt (common content)
pagename.php-left-1.txt pagename.php-middle-1.txt pagename.php-right-1.txt
left_2.txt(common content) middle_2.txt (common content) right_2.txt (common content)
pagename.php-left-3.txt pagename.php-middle-3.txt pagename.php-right-3.txt
left_4.txt(common content) middle_4.txt (common content) right_4.txt (common content)
  pagename.php-middle-5.txt  
  middle_6.txt (common content)  

 

Advanced:

If you want to use code in the content areas, you should not do it in the regular content files, because if you do it, the regular content files will no longer be editable with the wysiwyg editor. But you may put coded individual content in the '/content/page-settings/' files and coded common content in the '/content/main/MAIN.inc.php' file.

In the upper part of the content/main/MAIN.inc.php file resp. in the part below the functions inclusion but above the HEREDOC part of the '/page-settings/' files you may write your code. It might be helpful to use the 'obstart()' function sometimes...

In the lower part of the files there are so called php 'HEREDOC' areas already prepared, where you may put in the output. There you may also put regular html code, but as said before it is not recommended very strongly...

Considering the possibilities the page-settings/ files and the Main.inc.php file provides, the content of a page might be structures like this:

Overview about the included content files + HEREDOC elements

$main_left_0 (HEREDOC) $main_middle_0 (HEREDOC) $main_right_0 (HEREDOC)
left.txt (common content) middle.txt (common content) right.txt (common content)
$left_1 (HEREDOC) $middle_1 (HEREDOC) $right_1 (HEREDOC)
pagename.php-left-1.txt pagename.php-middle-1.txt pagename.php-right-1.txt
$main_left_2 (HEREDOC) $main_middle_2 (HEREDOC) $main_right_2 (HEREDOC)
eft_2.txt(common content) middle_2.txt (common content) right_2.txt (common content)
$left_3 (HEREDOC) $middle_3 (HEREDOC) $right_3 (HEREDOC)
pagename.php-left-3.txt pagename.php-middle-3.txt pagename.php-right-3.txt
$main_left_4 (HEREDOC) $main_middle_4 (HEREDOC) $main_right_4 (HEREDOC)
left.txt_4 (common content) middle_4.txt (common content) right_4.txt (common content)
  $middle_5 (HEREDOC)  
  pagename.php-middle-5.txt  
  $main_middle_6 (HEREDOC)  
  middle_6.txt (common content)  

By all means this I think should be enough to put content on the page...;)

 

Main Content and 'MAIN.inc.php'

While in the '/w3e/engine/engine.php' file (that you better not touch in no case) the common functionalities and elements are defined, the main content and some main functionalities that might need individual adjustment are defined using php code in the '/content/main/MAIN.inc.php' file. In the upper 'code' part of the file you can define and specify the elements, the lower HEREDOC part of the file contains the output of the main elements.

For all the main content is provided by this file either in the way, that it is defined here or in the way, that the in the '/w3e/engine/...' directory defined main elements and functionalities are put here for output, the 'MAIN.inc.php' file is quite important for the cms and you will often have to use it if you change or adjust general content elements of the site.

Currently in the 'Main.inc.php' file are defined the following page elements:
- Alternative design
- Header - standard, as gallery or as gallery in an iframe
- Dynamic news and dynamic news archive
- Some alternative styles
- Page bottom

For the 'MAIN.inc.php' file is included after the common w3easyCMS functions are included, you may use them in the file.

IMPORTANT: Whenever you need to have an intern link that will work from each file in any directory, you may realize it using the '$path' term in the beginning of the link. The '$path' term cares, that the link base is always from the root.

Example:
$href = $path."subfolder/file.php";

 

Multiple Multimedia Applications

The w3easyCMS gives you by the intergration of external multimedia applications the possibility to add image galleries (Galleria), videos (Flowplayer) or music (EMFF player) easily to your site.

Not only you can add single gallery-, video- or music files, but also directories of media files and you can set up the modules in a way that your visitors may select and run media files of their choice selecting them from the respective media directory.

To put multimedia files to a page, you first have to upload the respective files to the upload directory in the respective folder. Galleries are to be uploaded in the '/upload/images/galleries/' directory, .flv files in the '/upload/images/flash/' directory and .mp3 files in the '/upload/images/files/music/' directory.

Now you have to specify in the 'page-settings' file in the settings area, what kind of media you want to have on the page and in which way you want to have them. If you only specify 'yes', you can present a single multimedia file or a single gallery, if you specify 'multi', you provide a form where visitors can choose a multimedia file among others (if you have uploaded more than 1 file before).

Finally you have to specify the settings concerning the respective file(s) and multimedia applications in the 'MULTIMEDIA APPLICATIONS' part of the page-settings file.
Note, that you should use the 'type_multimedia.php' prototype file when creating a page with multimedia applications. If you want to change a 'regular' page into a page containing multimedia applications, it is enough to copy the 'MULTIMEDIA APPLICATIONS' part to the page-settings file, but be careful to put it exactly to the correct area of the file (below the inclusion of the 'functions.php' and above the 'page styles and page (java)scripts' section).

 

Images etc.

Please note, that images and all other files you want the visitors to regard on your site, have to be uploaded to the '/upload/xyz/' folders but not at all to the /content/xyz/' folders. This is necessary, because of the '/content/ folder cannot be accessed by visitors directly, for you should have protected the folder as it is strongly recommended. All the files in the '/content/' folder should only be visible as included parts of other files!

 

Template

The w3easyCMS comes with a flexible original template. Using this template you can change the layout variant of your site or even of a single page of yor site within a second. This means, you can have a template horizontal and vertical centered or you can have a template with no, 1 or 2 sidebars, and you can also adjust the sidebar width to several predefined sizes.
The template, it's kind and dimension is specified in the config file, but you can overwrite these settings at the individual page settings file to have different layouts on various pages.

Nonetheless you can also create your own template and use it for your site or just for some pages of your site.

Btw: Yes, its true: The main template consists of one single file (at least concerning the html code that defines the layout structure of your site resp. page).

 

Layout and Styles

As it suits to a cms the layout and styles section is strictly (hopefully...;) separated from the system and the content area. But if you use the common template, I'd recommend to adjust the styles not by overwriting the original styles but to copy the 'general.css' file, include it in the 'style.css.php' file below the original 'general.css' file and then change the settings there. So you always can reset to the original styles, if your attempt has gone the wrong way.
Btw: The navigation has a stylesheet of it's own.

 

Installation

Unpack and upload the w3easyCMS folder to your webspace.

Important: Now go to the admin area using the link on the bottom right. Call the w3easyProtect tool. Navigate within the tool to the /w3e/ folder and protect the '/w3e/' folder with .htaccess password protection.
Make sure, that also the .htaccess file in the content folder, i.e. the file '/content/.htaccess' exists and is intact. It's content should be:
Order Allow,Deny
Deny from all
That way nobody should be able to access the content folder directly from outside the server.

After you have protected the '/w3e/' folder and checked the protection of the '/content/' folder, make the
'/content/' folder and all it's subfolders
and also the
'/w3e/' folder and all it's subfolders
writable and also the content files and configuration files within these folders. Depending on your server settings you have to do nothing, if they are already writable or you have to chmod the directories to 777, 775 or 755 and the respective files to 666, 664 or 644. In doubt you will have to try it out by trying to edit them with the w3easyEditor. For security reasons you should always allow as less rights as possible.
Note: As I experienced lately, in some special secure server configurations files are generally not writable in a folder that is chmoded to 777, but they are writable, if the folder is set to 775 or 755.

To install and configure the w3easyTools and the external modules and prepare them for usage, refer to the respective manuals.

 

Configuration

To configure your cms online, open the w3easyEditor ('/w3e/admin/w3easyEditor/'), then navigate with the editor to '/w3e/engine/config.php' and open the file by pressing 'submit'. (Do not use the wysiwyg editor function to edit the config file or any other file containing code!!!)

There you will see a lot of entries to configure. But do not panic: Concerning most of the settings the default value will do for now. If you are in a hurry, at least specify resp. check the 4 entries in the GENERAL SETTINGS section and leave the other entries, that you do not want to deal with at once, as they are.

GENERAL SETTINGS

But maybe you know already your domain? So why not insert your domain?
$domain = "yourdomain.tld"; // (no 'http://' nor 'www' and no trainilng slash at the end!)

The term '$cfg' asks you, whether general cms settings shall overwrite page settings or not: 'top' means, that general cms settings will overwrite individual page settings, 'sub' means, that individual page settings will overwrite general cms settings.
$cfg = "sub"; // (default, recommended).
I'd also recommend to leave the
'$cfg_charset' as 'utf-8' and the
'$cfg_cfe' (content files extension) as 'txt'.

FEATURES SETTINGS

Now the time has come to have a look at some FEATURES the w3easyCMS provides.
The settings are self-explanatory.
Please note: The settings in the cms config file are (default) settings for all pages. F.e. if you want to have a comment function on all or most of your pages resp. if you want, that having a comment function should be the default status of each page, you should answer 'yes' to the '$cfg_comment' question. If you have set the '$cfg' to 'sub', you can overwrite these settings on every single page anyway.
But if you want to have a comment function only on few pages or maybe just on 1 page, you should leave the answer to the '$cfg_comment' question blank. As said before, you may overwrite this setting on the few or maybe the single page that you want to have a comment function.

Same with the other settings in the 'features' part.

Note, that in some cases it is not enough to specify the configuration settings to 'yes' to activate a module, but you also have to activate the respective module by specifying the settings in the module configuration and maybe create respective directories and create or upload respective files to the directory.

TEMPLATE SETTINGS

In the template settings section you first specify the main template for your site.
If you use the default w3easyCMS template, you can additional set the layout resp. dimensions concerning the sidebars. In a term like '125_523_160' the first number means the width of the left sidebar, the second number means the width of the middle content area and the third number the width of the right sidebar. If you have a term with only 1 or 2 numbers, the template has no resp. 1 sidebar and 1 middle content area. The higher number alway stands for the main content area.

PAGE SETTINGS

Most of the settings in the main config file you will meet again in the page-settings files. If you have allowed different settings for single pages in the General section of the main configuration, you can specify special page settings in the page-settings files, that differ from the settings in the main configuration.

NAVIGATION SETTINGS

Since version 0.07 the w3easyCMS has quite a sophisticated navigation concept. But don't panic: Even most of the special settings you can have the easy way, additional you can have some quite exotic features with the extended settings.

General navigation menu concept

1. Basically you can have with just one single navigation file one or two top navigation menus as well as a side navigation in one of the sidebars or even a combined navigation (example). Combined navigation means, that you have f.e. only the first level links in the top navigation and the sub links, that go from the respective active first level page, in the side bar menu. Further below we explain more in detail.

1.a. Concerning the top navigation you furthermore have the opportunity to have a (flyout) menu with horizontally arranged first level links and vertically arranged 2. and 3. level links ($navi_style = 'navi-top') or a (flyout) menu with all levels arranged horizontally ($navi_style = 'navi-top_h').

1.b. The sidebar navigation will be always vertically for obvious reasons...
($navi-style = 'navi-side')

2. The w3easyCMS menu structure consists of up to 3 levels. Please note: The navi menu structure is independent from the folder structure of your site. So do not mix it in your mind to not get confused...

3. The general settings for the navigation menu have to be done in the general configuration file ('/w3e/engine/config.php').
In the rare case, that you really need different page specific navigation settings, you can adjust the general settings in the respective page settings file. (Note, that in this case you might need an extended prototype file!)

Easy navigation menus

If you decide to have only either a top navigation or a sidebar navigation, you just have to specify the navigation file where the links are stored (default file is '/content/data/navilinks.inc.php') and you are done.

The default settings for the top navigation are:

$navi_top              = 'yes';
$navi_style            = 'navi-top';
$navi_kind             = 'all';

If you like, you may change the $navi_style to 'navi-top_h'.

The default settings for the sidebar navigations are:

$navi_side             = 'yes';
$navi_style            = 'navi-side';
$navi_kind             = 'flat';

If you like, you may change the $navi_kind to 'flat_2'.

Combined navigation menus

Combined navigation menus are more tricky. Here is an example for a combined navigation menu that I would recommend for a start.
If you are more experienced, you may try out other variants.

Top menu:
$navi_top              = 'yes';
$navi_style            = 'navi-top'; or 'navi-top_h';
$navi_kind             = 'all';
$navi_ml_first_top     = '1';
$navi_ml_last_top      = '1'; or '2';

Side menu:
$navi_side             = 'yes';
$navi_style            = 'navi-side';
$navi_kind             = 'combi_2';


Really wanna do it the hard way ?
Here is an explanation of all possible navigation settings

1. navi display
Here you specify, if you want to have a navigation menu in the respective location.
'navi_top2' means a navigation menu atop the middle content area.

$cfg_navi_top          = "yes"; // "no" // "yes"
$cfg_navi_top2         = ""; // "no" // "yes"
$cfg_navi_left         = ""; // "no" // "yes"
$cfg_navi_right        = "yes"; // "no" // "yes"


2. navi files (path from root to navilinks)
Here you specify the file, where the menu link data are stored. The first (general) entry is valid for all other entries, if those are not specified otherwise.
Only in rare special cases you will need more than one navigation file.

$cfg_navi_file         = "content/data/navilinks.inc.txt";
$cfg_navi_file_top     = ""; // path from root to navi file
$cfg_navi_file_top2    = ""; // path from root to navi file
$cfg_navi_file_left    = ""; // path from root to navi file
$cfg_navi_file_right   = ""; // path from root to navi file


3. navi kind
Here you specify the navi kind

'all'     - all links are displayed (if not hidden by css)
'flat'    - all 1. level links and the respective active link arm are displayed
'flat_2'  - like 'flat' + all 2. level links of active link arm are displayed
'combi'   - only direct sublinks of the active link are displayed
'combi_2' - only active link arms are displayed

$cfg_navi_kind_top     = "all"; // "", all, flat, flat_2, combi, combi_2
$cfg_navi_kind_top2    = "all"; // "", all, flat, flat_2, combi, combi_2
$cfg_navi_kind_left    = "flat"; // "", all, flat, flat_2, combi, combi_2
$cfg_navi_kind_right   = "combi"; // "", all, flat, flat_2, combi, combi_2


4. navi style
Here you specify the navi style.
'navi-top' means (flyout) menu with horizontally arranged first level links and vertically arranged second and third level links.
'navi-top_h' means (flyout) menu with all levels arranged horizontally.
'navi-side' means menu with all levels arranged vertically.

$cfg_navi_style_top    = "navi-top"; // navi-top, navi-top_h
$cfg_navi_style_top2   = "navi-top_h"; // navi-top, navi-top_h
$cfg_navi_style_left   = "navi-side"; // navi-side
$cfg_navi_style_right  = "navi-side"; // navi-side


5. navi start link
This setting seems to be obsolete now. But I left it for 'you never know...' and maybe compatibility reasons... It is strongly recommended to not use this feature anymore!!!
Here you may specify a link to the 1. first level menu link, that differs fromn the link specified in the menu link file. Path has to be from the root. (This was necessary in the past, when the 1. first-level link always went to an index file in the root. But now the 1. first level link goes where you specify it in the menu link file.)

$cfg_navi_start        = ''; // 'index.php'	
...


6. navi_ml_first and navi_ml_last
Here you can specify the menu levels, that shall be able to be displayed.
Leave blank, if all menu levels shall be able to be displayed.

$cfg_navi_ml_first     = ""; // "integer" (1, 2 or 3)
$cfg_navi_ml_last      = ""; // "integer" (1, 2 or 3)
...


7. navi_first and navi_last
Here you can specify link arms, that shall be able to be displayed.
Leave blank, if all link arms shall be able to be displayed.
The numbers that have to be entered to use this feature refer to the numbers of the respective link arms (first level links) in the navigation file.

$cfg_navi_first        = ""; // "integer"
$cfg_navi_last         = ""; // "integer"
...


Read about (creating or editing) the navigation file (menu link file) in the 'NAVIGATION' chapter!

 

w3easyTools Configuration

To configure the w3easyTools, please refer to the respective tool's help files.

 

External Modules Integration

Up to now the following applications are either already integrated in the w3easyCMS or an (easy!) integration is prepared:

External applications in the 'root/modules' folder:

- EMFF Player 0.5.8 (License: GPL 3)
- Flowplayer 3.2.7 (License: GPL 3)
- Galleria 1.2.6 (License: MIT)
- jquery-1.7.1.min.js (License: MIT, GPL)
- Lightbox JS v.2.51 (License: 'completely free to use')
- PHP Web Stat 4.3 (License: GPL 3)
- Share (iBeginShare) 2.6 ('free of charge', own licence)

External applications in the '/w3e/admin/w3easyAdmin/modules/' folder:

- CKEditor 3.6.1 (License: GPL, LGPL, MPL or commercial at your choice)
- KCFinder 2.51 2010-08-25 (License: GPLv2 & LGPLv2)
- JSrypt version from 2005, modified by w3easy.org in 2012 (License: Public Domain)
- PHFTP 4.2 (License: GPL 3)

Sure you could try to integrate the actual versions of these applications, but be aware, that there might have changed something so that the integration might not be the same as before.

 

General Integration

Depending on the external application there are 2 folders prepared to put the applications in.

Some external applications only have to be uploaded to the respective folder (and maybe the name of the folder has to be slightly adjusted), but there are some applications you have to add or change something or adjust some settings by yourself. 

To learn more about the integration and the usage of the external tools, please refer to the respective applications manuals, help files or (online) documentations.

 

Specific Integration

EMFF Music Player
Upload the application folder to the 'root/modules/' folder and name the script folder 'emff'.

Flowplayer
Upload the application folder to the 'root/modules/' folder and name the script folder 'flowplayer'.

Galleria
Upload the application folder to the 'root/modules/' folder and name the script folder 'galleria'.

jquery-1.7.1.min.js
Just upload the script to the 'root/modules/' folder.

Lightbox2
Upload the application folder to the 'root/modules/' folder and name the script folder 'lightbox2.51'. Adjust the paths to the referenced 'prevlabel.gif' and 'nextlabel.gif' files in the css file and adjust also the paths to the 'loading.gif' and the 'closelabel.gif'  near the top of the 'lightbox.js' file.
Read in the documentation about how to use the application.

PHP Web Stat
Upload the application folder to the 'root/modules/' folder and name the script folder 'stat'.

Share
Upload the subfolder 'share' within the application folder to the 'root/modules/' folder. (= folder name is 'share').

Concerning the integration of the below listed external applications, that are resp. that are to be integrated in the w3easyAdmin script, please refer to the w3easyAdmin manual:

CKEditor - Wysiwyg Editor
JSrypt - Text Encrytion Script)
KCFinder - File Manager, Uploader and Image Viewer
PHFTP - Online FTP Manager

(Backup Function)
(w3easyProtect - Directory Protection)

 

Usage of the w3easyCMS and the w3easyTools

To set up the content, administer and edit your pages the w3easyTools are made for. They come with help files or manuals to give you advice how to use them.

 

Backend / Administration

The main cms backend and administration area is located here: '/w3e/admin/'.
On this page you will find some general informations, links to the w3easyTools, to some external modules, to the logfiles and more.

 

File and Folder Manager and Editors

File and folder management, editing and a lot more is provided by the w3easyAdmin resp. the w3easyEditor.

Refer to the w3easyAdmin resp. the w3easyEditor help file.

 

Navigation

To set up or edit the default navigation file (/content/data/navilinks.txt) do as explained below:

For each navigation link you have - depending, in which folder the respective page is situated - up to 10 entries to make, separated by comma. Here is a description of each entry:

Order Example    Description
1 'ok' or '--' Shall the link be displayed in the navigation? 'ok' means yes, '--' means no
2 1,2,3,... Ordinary number of the 1. level link of the resp. link group
3 1,2,3,... Ordinary number of the 2. level link of the resp. link group
insert '0' (zero), if the link is a 1. level link
4 1,2,3,... Ordinary number of the 3. level link of the resp. link group
insert '0' (zero), if the link is a 1. or 2. level link
5 file.php file name of the page to link to. Leave blank, if the file name is 'index.php', but put a comma afterwards, as if there would have been made an entry.
6 Home Link title
7 1,2,3 Is the file in the /root/, in a /root/subfolder/ or in a /root/subfolder/subsubfolder/ ???
'1' = root/     '2' =  root/subfolder/     '3' = root/subfolder/subsubfolder/
8 'yes' or 'no' Does this menu item have submenu(s) or sublink(s)?
9 folder/ name of the subfolder/ (if the page is in a subfolder - with trailing slash)
10 folder/ name of the subsubfolder/ (if the page is in a subsubfolder - with trailing slash)


Btw: You may have more then 1 navigation file. If f.e. you have a main top navigation, you can establish a subnavigation maybe for the files in a special folder and place it in the sidebar or in the content area below the top navigation.  For this purpose the settings for the $navi_file_top2, $navi_file_left, $navi_file_right in the main /config.php or in the /page-settings/ files are used. In this case you have to create the respective additional navi files in the /content/data/ folder and link to it.

Read about the navigation setup in the Navigation Setup Chapter!

 

Creating new Pages (w3easyNewPage)

You can read in the w3easyNewPage manual how to create a new page technically.
In general the creating of a new page means to create at least 2 or 3 files: the 'regular' file to define the position in the file system, the /content/page-settings/ file to define the identity and the page settings and finally (not necessary, but recommended) at least one /content/pages/ file to easily add content to the file.
Furthermore you can create /content/pages/ files for the left or right sidebar. If you need more content files (see above), you will have to create them manually, but this will be no problem for content files are always empty .txt files when they are born.

Creating by Copying Prototypes

The /content/page-settings/ file is created by copying one of the file prototypes in the /w3e/prototypes/ directory. Since version 0.07 there are 4 file prototypes available: a regular file type and a multimedia file type containing the most important settings and 2 extended file types (regular and multimedia) containing all possible settings. At the moment the extended file types contain especially extended settings concerning the navigation. So if you plan to put a gallery or an flv-video or some music to the page, it is recommended to select the multimedia file prototype. (But you can also add the multimedia section in the multimedia file prototype to any common file to change it into a multimedia file), and if you plan to have individual (navigation) settings for a specific page you should consider chosing an extended file type to set up a new page (but again you can also add the needed special settings to a regular file type afterwards).

Note, that you have to specify the settings in the newly created /content/page-settings/ files manually after the file was created. Do not forget to change the file name, the page name and the title appropriate and to specify the subfolder(s) with trailing slash.

 

Uploads

For uploads you can use the upload function in the w3easyEditor or the w3easyAdmin tool, the KCFinder web file manager, the PHFTP online FTP manager or the ftp client on your pc.

 

Backup

You can backup your content files with the w3easyBackup tool, that is also integrated in the w3easyAdmin tool.
Note: The backup tool seems to have difficulties with large files and images and especially with images that have blanks in their title. So I'd recommend to exclude multimedia files and large images from the backup. Maybe the best way is to backup at first only the content folder and not at all the upload folder.
The database backup function is not tested by me so far for it is not needed for the w3easyCMS. It has been told, that there might be difficulties concerning the charset / collation of databases. So test it by yourself carefully before you use it!

 

Comment and Guestbook Script

Refer to the w3easyComment help file.

 

Contact Form Script

Refer to the w3easyContact help file.

 

News Module

Refer to the w3easyNews help file.

 

Folder Protection

Refer to the w3easyProtect help file.

 

Logfiles

Refer to the w3easyLogs manual

 

w3easyToolbox

Refer to the w3easyToolbox help file.

 

Known (and unknown) problems

There is always a good chance to get in trouble because of a function is called twice. Then you will read on your monitor something like this: 'cannot redeclare function...'. In these cases it might be, that the same function is included as in the w3easyCMS function file as in a w3easyTools function file. F.e. if you try to include a dynamic archive file or the comment module twice in a page, the included function is called twice. In some of these cases the problem can be solved, if you deactivate (outcomment) the respective function in the w3easyTool (as far as the function is included in the w3easyCMS function file), but note, that presumable you will not be able to use the w3easyTool in another environement without the deactivated function.

When specifying directories or folders in the configuration files of the w3easyCMS and also of the w3easyTools, you always have to check carefully, whether it is required to add a trailing slash to the folder name or not.
Furthermore concerning specifying files and folders, you have to observe exactly, whether it is required to specify the  relative path to the file/folder or maybe the path from the root of your site.

If you have problems with your navigation, note, that the file name, the navi title and the subfolder names (with trailing slash!) that you specify in the navigation file, exactly match the respective terms in the respective page settings file.

I noticed, that the Lightbox2 module doesn't work on a page that has a gallery module added. Presumably it is a conflict between the included javasript functions.
This problem seemed solved now with the new Lightbox2.51 version using the 'jquery.xy' script, but unfortunately it is not.

There might be more compatibility problems using several modules on the same page.

 

This is (not) the end...

The w3easyCMS documentation is presumable not yet complete nor enough elaborated so far. And it is written in a hurry and surely not a linguistic goody I fear...
We will continue to work it over and improve it last but not least according to the field reports we might get. But anyway we hope it will right now already help you to manage the w3easyCMS.

Zorry for my poor English & take it w3easy...;)

Last edit: 2012-12-17 ⊗ 20:33

cms: w3easy | webdesign: w3nord

w3easy.org cms project: clear - modular - solid   facebook

contact | legal | admin