Yana Manual

english version

Logo

This software is aimed at SMB, professional software developers and private individuals. It is a platform for the development of programs on the Internet, a corporate network or a desktop computer. Current software technologies to simplify or speed up your work are supported. For example: Rapid-Prototyping or Product Family Engineering.
For individuals, there are a number of pre-installed applications, which may be used immediately, even without any programming knowledge.
This manual explains the installation, configuration and operation of the software.

Reference search

This manual has a search function, which makes it possible for you to search all texts.
Please note: In order to be able to use this function, you must have Java and Javascript activated in your browser.

table of contents

  1. General introduction

    1. Prelude
    2. Description
    3. system requirements
    4. Notes on compatibility

    5. included files

      1. Files
      2. common directories
      3. directories, where your extensions and applications are stored
      4. configuration files

  2. Copyright and legal issues

    1. Licences
    2. Summary
    3. Participating in this project

  3. Beginner's Guide

    1. Installation

      1. automatic installation
      2. manual installation
        1. Example: Setting access rights

    2. Configuration

      1. open online menu
      2. Choose password
      3. Edit settings

  4. Advanced User's Guide:

    1. Installation (summary)
    2. Configuration
    3. General information
    4. for further reading

  5. Frequently Asked Questions

    1. I got a problem with the automated installation. How do I install the software manually?
    2. What should I do if I run into a problem during configuration of the database connection?
    3. If I call the file "index.php" in my web browser, only the source code is shown. Why?
    4. Forgotten passwords
    5. Adding own smilies and icons
    6. Problems with the installation
    7. Using the database prefix
    8. Disable site map

    9. Formatting entries with EmbTags

      1. Why not use HTML in web forms?
      2. What formatting options are there?
      3. Using your own tags
    10. My question is still non answered - what am I to do?

  6. Extensions

    1. How to use the administration panel

      1. Settings in basic mode
      2. Settings in expert mode

    2. Install skins

      1. Instructions
      2. Troubleshooting

    3. Install plug-ins

      1. Instructions
      2. Troubleshooting

    4. Install language packs

      1. Instructions
      2. Troubleshooting

    5. Plug-in: Guestbook

      1. General introduction
      2. install plugin
      3. install database (optional)
      4. Basic settings
      5. E. mail notifications
      6. Multiple guestbooks
      7. Multiple layouts for the same guestbook
      8. Protection from unwanted advertisements
      9. List of important data fields for the interested developer

    6. Plugin: Anti-Spam

      1. General introduction
      2. Configurations

    7. Plug-in: DB administration

      1. General introduction
      2. Setting a database connection
      3. Troubleshooting
      4. install databases
      5. Synchronize databases
      6. Creating a backup

    8. Plug-in: Search Engine

      1. General introduction
      2. Features
      3. included files
      4. Installation
      5. Creating the search index
        1. Creating the search index offline
          1. Installation of Java
          2. Start indexing software
          3. Alternatively: you may use the command line interface
          4. Using the administrator's menu to upload the search index
        2. Creating the search index online
          1. Using the administrator's menu
      6. Frequently Asked Questions
        1. What informations are stored?
        2. Some documents have changed. What am I to do to have the new files found as well?
        3. I have created a new search index, but the old results are still viewed.
        4. Nothing or 0 hits are shown.
        5. What is the difference between "start.bat", "suchIndexErstellen.bat" and &qu ...
        6. I'm getting an error: "Error 500 search index not found".
        7. I'm getting an error: "Error 404 page not found".
        8. When searching I'm getting an error: "Error 403 access denied".
        9. I tried to run the file "start.bat", but it didn't work.

    9. Plug-in: RSS-to-HTML Factory

      1. General introduction
      2. Who should use this plug-in?
      3. Installation

    10. Plug-in: Software Development Kit (SDK)

      1. General introduction
      2. Installation
      3. Preparation
      4. Interface
      5. Database
      6. Installation (SQL)
      7. Complete

  7. Developer's Manual

    1. Before you start...

    2. Editors for the Yana Framework

      1. General introduction
      2. Integration in ConTEXT
        1. Installation
        2. Use
          1. 1. Example: editing a database schema file
          2. 2. Example: Editing a template
          3. 3. Example: Using text blocks / code snippets
      3. Integration in PSPad
        1. Installation
        2. Use
          1. 1. Example: editing a plug-in
          2. 2. Example: using text blocks (Clips)

    3. Creating templates and skins

      1. Editing HTML-templates
        1. Step-by-step instructions
      2. Configure templates and skins
        1. Configuration of Skins
        2. Configuration of templates
      3. List of permitted principal wildcards

    4. Reference manual of the template engine

      1. General introduction
      2. Modifications of the syntax
        1. Token delimiters
        2. Naming conventions
        3. Paths
        4. Configuration
      3. New functions
        1. captcha
        2. create
        3. embeddedTags
        4. import
        5. preview
        6. printArray
        7. printUnorderedList
        8. rss
        9. sizeOf
        10. smilies
        11. smlLoad
        12. sml_load
        13. varDump
      4. New modifiers
        1. css
        2. date
        3. embeddedTags
        4. href
        5. smilies
        6. url
        7. urlEncode

    5. Creating plug-ins and applications

      1. General introduction
      2. Software Development Kit (YANA-SDK)
        1. Step 1: General information
        2. Step 2: edit interface
        3. Step 3: Generate the GUI
        4. Step 4: Create an installation routine
      3. Creating the application
      4. install plugin

    6. Creating translations

      1. General introduction
      2. Editing translations
      3. Generating new language packs

    7. Coding Principles

      1. General introduction
      2. Indention and comments
      3. Declarations and lifetime of variables
      4. If and Else statements
      5. Switch statement
      6. For, ForEach and While statements
      7. Classes and functions

    8. API documentation

    9. Cookbook

      1. Working with databases
        1. General introduction
          1. Which features are supported?
          2. Which features are not supported?
        2. How do I open a connection to a database?
          1. Open a database connection with the current connecting data
          2. Open a connection to a database with individual connecting data
        3. How do I know if the database has been activated through the administrator's menu?
        4. How do I create a database query?
        5. How do I execute INSERT- / UPDATE- statements?
        6. How do I execute a DELETE statement?
        7. How do I know how many rows a table has?
        8. How do I know if a table / row exists?
        9. How do I create an installation routine for my tables?
        10. How do I import a SQL file containing DDL instructions?
        11. How do I import data from a CSV-file?
      2. Working with the schema of a database
        1. How do I export a database schema to a file?
        2. Contents of a structure file
        3. How do I write my own database schema?
        4. How do I create a foreign-key?
        5. Relation between database schemata and the template function [%create ...%]
          1. Representation of data types
          2. Special configuration of the data types "image" and "file"
      3. File system
        1. How do I get the content of directories?
        2. How do I create or delete directories?
        3. How do I read the contents of a configuration file or SML file?
        4. How do I write a variable to a config file or SML file?
        5. How do I copy a file?
      4. Counters and statistics
        1. How do I create a counter?
        2. How do I recall the counter status?
        3. How do I create a graphical counter?
      5. E-mails
        1. General introduction on sending mails
        2. How do I send a text as mail?
        3. How do I send an e-mail based on a template?
        4. How do I send form data as a mail?
      6. Check form data
        1. How do I check user input prior to processing it?
      7. Logging and error messages
        1. Where can I find the log data?
        2. How do I enable logging?
        3. How do I create a log entry?
        4. How do I create an error message?
          1. Creating error messages
          2. Use
          3. Exiting the program
      8. Reading and writing of profile settings
        1. General introduction
        2. How do I read variables from the global memory?
        3. How do I write variables to the global memory?
        4. How do I deleted variables from the global memory?
        5. How do I change the type of a variable in global memory?
        6. What interesting data can be found in global memory?
          1. List of installed plug-ins
          2. Current profile settings
          3. Default settings
          4. User Information
      9. Using a CAPTCHA
        1. General introduction
        2. How do I use a CAPTCHA in my plug-in?
        3. For version older than 2.9.3
      10. Editing plug-ins
        1. How do I define the interfaces?
        2. How do I add new actions?
        3. How do I create a setup menu?
      11. Graphics and photos
        1. How do I load an image from a file?
        2. How do I load an image from a string?
        3. How do I create a new (empty) image?
        4. How do I create a thumbnail?
        5.  How do I create a form to upload pictures?
        6. How do I draw lines, geometric figures and text?
          1. Details on use of colors
        7. Which graphic filters and effects are there?
      12. Create multicolumn layouts
        1. General introduction
        2. How do I create 2 columns?
        3. How do I create 3 columns?
        4. How do I create 4 or more columns?
      13. Create tree menus
        1. General introduction
        2. How do I create a foldable menu?
        3. How do I create a horizontal menu?
        4. How do I create a tree menu?
        5. How can I have menus created automatically?
      14. Miscellaneous functions
        1. How do I call an action of another plug-in?
        2. How do I empty the template cache of the server?
        3. How do I create a preview for an entry, eg. in a forum?
        4. How do I create "micro-summaries" for Firefox 2.0 and higher?
        5. How do I create RSS feeds?

    10. Tutorials

      1. my first plug-in
        1. Chapter 1: Preparation
        2. Chapter 2: Creating the database
          1. Introduction to the main properties of a table column
          2. Refining the input
          3. Multiple blogs in one table
          4. References
        3. Chapter 3: Creating a new plug-in
          1. Try the new plug-in
          2. Instructions for users with database support
          3. Notes on the operation of the editor
          4. References
        4. Chapter 4: Editing templates and configuration files
          1. Insertion of emot-icons and embedded tags
          2. Changing the sorting order
          3. Editing the entries of the tree menu
          4. Editing configuration files
          5. References
        5. Chapter 5: Editing the PHP source code
          1. Defining a new action in the interface section of the configuration file
          2. Writing the PHP source code
          3. Query the database
          4. Add a new parameter
          5. References
        6. Chapter 6: Summary
          1. Source codes
      2. Put PHP programs on CD-ROM
        1. system requirements
        2. Chapter 1: Download the sources
        3. Chapter 2: Preparations for CD-ROM version
          1. Basic installation
          2. Database configuration
          3. Server2Go - Configuration
        4. Chapter 3: Use with Firefox Portable
          1. Install Firefox Portable
          2. Configure Server2Go for Firefox Portable

  8. Article

    1. XML Data Definition Language Format

      1. Abstract
      2. State of this document
      3. Definitions
        1. Terminology
        2. Glossary
        3. Miscellaneous
      4. Database
        1. Element Database
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        2. Element Description
          1. Description
          2. Presentation
        3. Element Include
          1. Description
          2. Implementation
        4. Element Sequence
          1. Attributes
          2. Description
          3. Implementation
        5. Element Initialization
          1. Attributes
          2. Description
          3. Implementation
      5. Tables
        1. Element Table
          1. Attributes
          2. Description
          3. Implementation of inheritance
        2. Element Grant
          1. Attributes
          2. Description
          3. Beispiele
          4. Implementation
        3. Element Primarykey
          1. Description
          2. Implementation
        4. Element Declaration
          1. Description
        5. Element Trigger
          1. Attributes
          2. Description
          3. Implementation
        6. Element Constraint
          1. Attributes
          2. Description
          3. Implementation
        7. Element Bool
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        8. Element Default
          1. Attributes
          2. Description
          3. Implementation
        9. Element Integer
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        10. Element Float
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        11. Element String
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        12. Element Mail
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        13. Element Url
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        14. Element Password
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        15. Element Inet
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        16. Element Text
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        17. Element Html
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        18. Element Date
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        19. Element Time
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        20. Element Timestamp
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        21. Element Enum
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        22. Element Option
          1. Attributes
          2. Description
        23. Element Set
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        24. Element List
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        25. Element Array
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        26. Element File
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        27. Element Image
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        28. Element Reference
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        29. Element Foreign
          1. Attributes
          2. Description
          3. Implementation
        30. Element Key
          1. Attributes
          2. Description
        31. Element Index
          1. Attributes
          2. Description
          3. Implementation
        32. Element Column
          1. Attributes
          2. Description
          3. Implementation
      6. Views
        1. Element View
          1. Attributes
          2. Description
          3. Implementation
        2. Element Select
          1. Attributes
          2. Description
        3. Element Field
          1. Attributes
          2. Description
      7. Forms
        1. Element Form
          1. Attributes
          2. Description
          3. Implementation
          4. Presentation
        2. Element Fieldset
          1. Attributes
          2. Description
          3. Presentation
        3. Element Input
          1. Attributes
          2. Description
          3. Presentation
        4. Element action
          1. Attributes
          2. Description
          3. Presentation
        5. Element Event
          1. Attributes
          2. Description
      8. Functions
        1. Element function
          1. Attributes
          2. Description
        2. Element implemetation
          1. Attributes
          2. Description
          3. Implementation
        3. Element param
          1. Attributes
          2. Description
        4. Element return
          1. Description
        5. Element code
          1. Description
      9. ChangeLog
        1. Element changelog
          1. Description
          2. Implementation
        2. Element create
          1. Attributes
          2. Description
        3. Element rename
          1. Attributes
          2. Description
        4. Element drop
          1. Attributes
          2. Description
        5. Element update
          1. Attributes
          2. Description
        6. Element sql
          1. Attributes
          2. Description

    2. The SML file format

      1. Purpose of the SML format
        1. Discussion on detection of infinite recursion
      2. XML to SML
      3. Syntactic properties
        1. Example
          1. scalar variables
          2. numeric data fields
          3. associative data fields
          4. multi-dimensional and mixed data fields
      4. Alternatives to SML
        1. XML parser
        2. SimpleXML
        3. Initialization files
        4. JSON
        5. Using "serialize" and "unserialize"
        6. for further reading

    3. Spam und Flooding

      1. Definition
      2. Spam in forums and guest books
        1. Reactive measures
        2. Preventive measures
      3. Vanadalism and flooding in forums and guest books
        1. Example Scenario
        2. Prevention of such scenarios
      4. for further reading

    4. Encryption

      1. DES-algorithm
      2. MD5-algorithm
        1. for further reading
license information: Yana PHP-Framework  (GPL), Smarty, PCL-Zip  (LGPL) version date: 20.09.2009 version number: 3.1.0