project page


SourceForge Logo
  Getting started| Project file| Definition file| Tag file| Source file| Functions| Template file

How to create a project file

Below is an example of a project file



TAG_FILE = preppy.tag
DEFINITION_FILE = preppy.def
TEMPLATE = main.vtp
NO_TEMPLATE = in/index.txt

DATE = dd/mm/yyyy__hh:min12
MDATE = th_month,_yyyy_wday_night
IMG_DIR = out/img

TEMPLATE = DIR = in/features
TEMPLATE = DIR = in/faq
TEMPLATE = DIR = in/download
TEMPLATE = DIR = in/credits
TEMPLATE = DIR = in/desc
TEMPLATE = manual.vtp DIR = in/manual

  • INPUT_DIR: input directory of source files, without leading and ending slash, relative to the location of the project file. For example, the project file is in /home/user/preppy/project.vpj and source files are inside /home/user/preppy/in/, then the INPUT_DIR is "in".

  • OUTPUT_DIR: same convention as that for INPUT_DIR, e.g. if you want out directory to be /home/user/preppy/out/netscape/, then the OUTPUT_DIR will be "out/netscape".

  • OUTPUT_EXTENSTION: extension of the files generated, usually it's .html for webpages, if you use preppy for something else, you can use other extentions.

  • TAG_FILE: the file storing tag. It can be with any extension, for clarity, usually I use the extension .tag, relative to the location of the project file, usually it resides in the same directory as the project file, typical value is "filename.tag" (this file has to be existing!). If it's in another directory, e.g. project file is in /home/user/preppy/ and tag file is in /home/user/preppy/misc/ then you can enter "misc/filename.tag". (Later we'll explain what to put in the tag file)

  • DEFINITION_FILE: the file storing definition. The rules are the same as for tag file.e.g. "filename.def"

  • TEMPLATE: the template file to be used, the rules are the same as for tag file.e.g. "filename.vtp"

  • NO_TEMPLATE: files that will not be merged into a template. But substitution of tag and definition will still take place. Same rules as above, for example, for the file "/home/user/preppy/in/index.txt", you should enter "in/index.txt".

  • DATE: the format the function date will use, it'll be explained later.

  • MDATE: the format the function mdate (last modification date) will use.

  • IMG_DIR: the directory images are stored, you can leave empty. It's used for resolving path when you use image function. (if you don't enter anything here, by default it'll search for the image relative to the location of the source file). Again it's relative to the location of the project file.

  • UPDATED_FILE_LIST: possible values are "YES" or "NO", if it's yes, a file called "updated_file_list.log" will be created in the directory of the project file listing all the files that are updated.

  • <SECTION section_name> :name of a section, inside a section, you can define TEMPLATE and INPUT_DIR, they're the same as that of above, except they're used for this section only. For example INPUT_DIR = in/section1, TEMPLATE = section1.vtp, then all files under the directory in/section1 (and subdirectories) will use the template section1.vtp instead of the default one (main.vtp), if you leave TEMPLATE empty, it'll use the default template, but if sectional definition or tag exist, it'll use the sectional one. (the different colors of this site is accomplised by using section without specific template.)N.B. no section should be named "default", as values outside a section is considered to be in the section default.

    Definition file


    Copyright ©  2001 vaivai.com.All rights reserved.