phpGUI - Auxiliary Files:


There are some tools to assist you, and which can be tailored for each site (project) individually.
  What is it: Filetype:
1. Skeletons *.skl
2. Code-Snippets *.csg
3. Include-Files *.inc
4. Color-Palettes *.pal


In general:
Skeletons and code-snippets have project-global defaults (color-palettes have not). All skeletons, code-snippets and color-palettes which are specific to a project must be copied into a special subdirectory of the apropriate project-directory named #phpGUI. If in this subdirectory a skeleton-file or a code-segment-file or a palette-file cannot be found, then the default-version of the phpGUI-directory will be used.


Skeletons (Templates):

There is a skeleton-file for each of the following file-types:
  • html-files
  • php-files
A skeleton-file is a file containing a certain basic structure which is assumed to be valid for all instances of that file-type. Skeletons are used whenever the function 'New file' is invoked (php or html).

A default-skeleton-file for each file-type is supplied with the installation of phpGUI. These files may be modified arbitrarily so they fit the individual needs, global or site-specific.

There are two skeleton-files:
html.skl and php.skl.

Remember:
The project-spezific skeleton-files must be copied into the subdirectory called <project>\#phpGUI.


Code-Snippets (Code-Segments):

A code-snippet (or code-segment) is a predefined sequence of code (ascii-lines). All code-snippets of the same type are stored into one file (with filetype '.csg). At request via context-menu all available code-segments are listed in a drop-down-listbox where you can select one from, which will immediately be pasted into your currently edited file, at the current cursor position.

There exist these types of code-segments:
  • html.csg
  • php.csg
  • MySQL.csg (which is php-code specially used in a database-environment)
The files may contain any number of code-segments. Each code-segment is headed by a header-line containing primarily the name of the code-segment. Have a look into one of the supplied csg-files and the simple structure will be very clear to you.

A code-segment can be selected via context-menu 'Insert code ...'


Include-Files:

Similar to code-snippets include-files also contain html- or php-code. While code-snippets become an integral part of the code-file where they are inserted, this is not so with include-files. An include-file is included in the code-file only by reference, i.e. only a special include-command is inserted in the code file, naming an include-file, which is resolved only at upload-time .

The include-command looks like this:
 <:[name-of-include-file] 
For example, if you want to have a file named 'Navi.inc' included in a code-file:
 <:Navi.inc [#keyword1=value1[#keyword2=value2[...]]]
Important: the include-command must be placed at position 1 in a line.

A typical use of include-files are navigation-bars in your web-page; such a navi-bar often is placed several times in a web-page, which results in several identical code-sequences. Modifying this navi-bar would mean you have to do the modification in several parts of your file. With include-files you do the modification only once, namely in the include-file.

Because include-files are resolved (i.e. made part of the proper file) only when they are uploaded this means that you cannot view the effect of the include-files when you start your browser locally. You see it only when viewing the file from the remote web-server.


Color-Palettes:

Professional web-design always obeys to certain rules concerning the usage of colors. Web-pages which abound with colors of all kind don't appear very professional.

That's the reason why the web-developer should constrain to a specific color-palette for each project, a palette which contains a small number of different colors which represent the 'soul' of his site.

With the help of a tool called Color-Mixer in phpGUI it is very easy to create colors, especially of similar appearance, and to store them in a (project-specific) palette-file (with file-type '.pal'). Color-gradients are generated very easily by built-in functions.


back to main page