NavDaF Documentation Version
1.00
>up-dir< Installation Example Changelog Todo
Release notes Addons Versionning  
 

NavDaF Documentation


What is NavDaF?

NavDaF (aka "Navigation for Directories and Files") provides classes and scripts to be implemented in a website by a developer/webmaster so users may easily navigate through this website.

NavDaF is intended for small sites that don't use a CMS but maybe some editors like Dreamweaver. The scripts and classes then may be implemented in the templates to display navigational layout elements like directory and file indexes of the current directory on all or many pages of the site.

Key facts:

  • Programming language: PHP (scripts, functions or classes)
  • OS: OS-independent (hopefully all OS that PHP is running on)
  • Data access: only current files within the website (or include path), no database access
  • CSS: all layout handling is configurated via css files (no formatting within php)
  • Configuration: all configuration is done within seperate configuration files (e.g. navigation.ini.php), mainly INI-files
  • Semaphore files: with semaphore files you may influence the behavior of NavDaF (e.g. no file listing of a directory will be shown when the the file ".ignorenav_files" exists in that directory)

License

The glorious NavDaF ist distributed under the terms of GPL.


Requirements

  • You will need a webserver running PHP 4.2 (or later).
  • The php.ini option "allow_url_fopen" must be set to true (1) because NavDaF may try to open files via URL.

And - of course - you will need a filesystem because NavDaF is based on reading files in the filesystem. No, you don't need a database like MySQL.


About this documentation

This documentation is made of pure old HTML4 spiced with some CSS. Sometimes you will find some dressing like files in the very pure old text format. That's it!

  • no javascript
  • no php
  • no jsp
  • no asp (aargh!)
  • no spam at all!

No rule without exception: you may encounter example files in the addon section that are PHP files. They won't work in the current directory structure. You have to change their PHP code and install NavDaF before they work!

All hyperlinks in this documentation target to this directory or a subdirectory below unless otherwise stated. Consistently you will find three kinds of hyperlinks in this documentation:

  • documentation hyperlinks
    They point to this directory or below. No special marking.
  • internet hyperlinks
    Internet hyperlinks target to any other server and have a protocol prefix (like "http://"). After such a hyperlink you will read "(internet)". Those hyperlinks will open in a new window.
  • package hyperlinks
    Those hyperlinks target to the local directory one level up and then somewhere below (like "../phpdoc/index.html"). Those hyperlinks are marked with "(package link)". Those hyperlinks will open in a new window.

Content of this documentation

This documentation gives you information related to


Contact information

You will find additional information on the NavDaF Homepage (intenet) and on the NavDaF project (internet) at sourceforge.net (internet).

If you have questions feel free to drop me an email at fwhamm@users.sourceforge.net. You may write either in english or in german.

Frank Hamm (author of NavDaF)