plugins/appwizard/README.dox

0001 /** \class AppWizardPlugin
0002 Application Wizard.
0003
0004 \verbatim
0005 The config files for the application Wizard understands following options
0006
0007 Group [General]
0008 Name:      this name will be displayed in the Treeview (Application Wizard)
0009 Icon:      a screenshot from your application (190x140 pixel)
0010 Category:  the category, will we displayed hierarchic in a
0011            treeview (current implementation)
0012 Comment:   a small comment for the template, longer comments should go
0013            into a README.devel and shown on startup
0014 ShowFilesAfterGeneration:
0015            this comma separated list of files will be opened after the project
0016            generation, for instance a readme, path is relative to the project dir,
0017            APPNAMEUC will be replaced with the project name in uppercase,
0018            APPNAMELC will be replaced with the project name in lowercase,
0019            APPNAME will be replaced with the project name.
0020            (example: ShowFilesAfterGeneration=README.devel,APPNAMELC_plugin.cpp)
0021 DefaultDestinatonDir:
0022            changes the default destination dir for the project (~)
0023            to your value, HOMEDIR is a keyword
0024 FileTemplates:
0025            a list of pairs of strings, where the first element is the
0026            name a file template to be created, and the second element
0027            is either CStyle, PStyle, ShellStyle, or None. With CStyle, the
0028            application wizard proposes a file header in C comment style.
0029            With PStyle the application wizard creates a header
0030            in Pascal comment style. With ShellStyle, the application
0031            wizard creates a header in shell comment style.
0032
0033 an example for a php template:
0034
0035 [General]
0036 Name=Simple PHP script
0037 Category=PHP
0038 Comment=This generates a simplistic 'Hello world' program in PHP (https://www.php.net/)
0039 Icon= php.png
0040 ShowFilesAfterGeneration=README.devel
0041 DefaultDestinatonDir=HOMEDIR/public_html
0042 FileTemplates=php,ShellStyle
0043
0044 The template project files (*.kdevelop) defines which parts are
0045 loaded for the project and how they are configured. The set of
0046 loaded parts is primarily determined by a set of key words.
0047 The following keywords are currently used:
0048
0049 C         C language
0050 C++       C++ language
0051 Java      Java language
0052 Pascal    Pascal language
0053 Python    Python language
0054 PHP       PHP language
0055 Perl      Perl language
0056 Code      Compiled to native, debuggable code
0057 JVM       Executed and debugged in the Java VM
0058 GBA       Game Boy Advance
0059 KDE       KDE application/applet
0060 Qt        Qt based
0061 Kicker    Kicker applet
0062 kioslave  KDE ioslave
0063 KOffice   KOffice application
0064 KDevelop  KDevelop plugin
0065 GNOME     GNOME application
0066 \endverbatim
0067
0068 \authors <a href="mailto:bernd AT kdevelop.org">Bernd Gehrmann</a>
0069
0070 \feature Provide a basic application framework (for plugins and applications for many languages) that you can use as a starting point.
0071 \feature Development for 3rd party developers made easy. :)
0072 \feature A further step to rapid application development (RAD).
0073
0074 \bug bugs in <a href=https://bugs.kde.org/buglist.cgi?component=appwizard&product=kdevplatform&resolution=---">appwizard component at Bugzilla database</a>
0075 \bug The C/C++ applications use libtool as a degugging shell. That doesn't work. Please remove libtool from "Project Options...-> Debugger -> Debugging Shell" to make them work.
0076
0077 \requirement <a href="https://www.perl.com/"> perl </a> >= 5.004
0078
0079
0080 */