lazarus/components/projecttemplates
mattias 245402981f renamed README files to README.txt
git-svn-id: trunk@9657 -
2006-07-21 18:31:15 +00:00
..
frmtemplatesettings.lfm + Added menu integration and a README file 2005-09-30 19:28:32 +00:00
frmtemplatesettings.lrs set button/bitbtn borderspacing.innerborder to 4 2006-05-22 08:10:49 +00:00
frmtemplatesettings.pas added Michael VCs packages to create project templates and customforms for the IDE 2005-07-30 11:56:08 +00:00
frmtemplatevariables.lfm + Added menu integration and a README file 2005-09-30 19:28:32 +00:00
frmtemplatevariables.lrs set button/bitbtn borderspacing.innerborder to 4 2006-05-22 08:10:49 +00:00
frmtemplatevariables.pas + Added menu integration and a README file 2005-09-30 19:28:32 +00:00
idetemplateproject.pp moved ideintf/configstorage.pas to lcl/lazconfigstorage.pas 2006-05-13 11:44:14 +00:00
Makefile win64 fixes (from peter, modified) 2006-05-01 21:47:48 +00:00
Makefile.fpc Makefile custom options are now platform independent 2006-01-21 09:46:15 +00:00
projecttemplates.pp fixed FindNext finding empty filename 2005-08-30 17:41:53 +00:00
projtemplates.lpk added to bigide: jpeg, projecttemplates, fpcunit 2006-01-20 23:13:19 +00:00
projtemplates.pas added Michael VCs packages to create project templates and customforms for the IDE 2005-07-30 11:56:08 +00:00
README.txt renamed README files to README.txt 2006-07-21 18:31:15 +00:00

This package implements project templates.

Installing this package in the IDE adds a category to the 'File-New' dialog:
'Template projects'

It also adds a 'New project from Template' menu item to the 'File' menu, as
well as a 'project template options' menu under the 'Tools' menu.

In the 'Project template options', a directory can be selected. This project
should contain a subdirectory per template. Each template directory contains
a template for a project: A collection of files which will be copied and
used as a new project.

During the copy, the package will scan the file/directory names and the 
contents of the files for variable substitution: $(VARNAME) will be 
replaced by the value of a variable $(VARNAME).

By default, the engine knows 2 variables:
ProjDir  : The directory where the new project will be created.
ProjName : The name of the project.

Additional variables must be defined in a file called 'project.ini' in the
directory of the project. This is a file in Windows INI format.

The section [Variables] will be scanned for variable names:
[Variables]
VarName1=Description 1
VarName2=Description 2

The variables found will be presented with their description in a dialog, 
and the user must present a value for the variables.

The 'project.ini' file can contain a second section, called 'Project', which
can contain some info about the project. The following keywords can be found
there:

Name
  Name of the template 
Author
  Author of the template
Description
  Short (one-line) description of the project
Recurse
  A boolean value (1/0) which tells the engine to recurse in subdirectories
  or not.
Exclude
  Comma separated list of filename extensions which should not be searched
  for keyword subsitution.

The Name,Author and description will be presented in the 'File-New' dialog.