yanaframework.net

[admin]

General stuff
===================================

Q: "What is the YANA framework?"
--------------------------------------------------------------

A: Yana is a PHP component framework, which's main task is to reduce the amount of work required for development and maintenance, by automated processes and increasing the number of components of an application, that can be designed for reuse, while reducing redundant informations in the source code and putting parameters in global, easy-to-read configuration files.

In other words: it is a program that allows you to write, expand and maintain other programs with ease.

Asking on "how easy"? Let's say: the tutorial explains how to write a blog program within 30 minutes. So it's obviously as easy as that.


Q: "What does the name 'YANA' stand for?"
--------------------------------------------------------------

A: The name "YANA" is an abbreviation for "Yet ANother Architecture".

Also Yana is a well-sounding female first name and shares 50% of it's letters with the name of my home town.


Q: "What's so special about it?"
--------------------------------------------------------------

A: The framework offers a code-generator for rapid-prototyping. It has the ability to change your data model at a glance in a simple text file and have all your forms and code applying your changes at once without needing to change anything. So you are able to create your customer's application while sitting next to him and speak about it. You may add changes, like a new column to a table, while you speak and your customer can actually watch "his" application grow. Not on paper but in reality.

Applications are easy to extend, since they all consist of black-box components. For example: adding a junk-filter may be nothing more complicated then installing a new plugin. The additional component applies to and may be used not only by one - but by ALL other components. Either written in the past or the future.

In addition the framework offers a class library to aid you with your daily work.


Q: "I've read about something called 'database structure files'. What is it and why should I care?"
--------------------------------------------------------------

A: These are documents, describing the structure of a table and it's relation to others.

If you know what the structure of a database is and understand a minimum of the semantics, you can do amazing things with this information. The framework can create SQL DDL statements on the fly, create forms to view, search, and edit entries in the database. It can check form data, build queries and check your queries. It provides semantic datatypes like "image", "ip", "url", or "mail". It automatically resolves foreign key references, if you access them. Building an SQL-query is as easy as writing down: TABLE.ROW.COL. If COL is a foreign key you may even access the columns within the table the foreign key points to like: TABLE.ROW.COL.ANOTHER. No need for joins, sub-selects or any other. The framework can do it on it's own, because it "knows" where to look.


Q: "Anything else?"
--------------------------------------------------------------

A: Yes. There is support for skins, multiple languages, plugins and multiple users. You may save several profiles and provide the same application for several websites from a single installation and control them all from a single administration panel.

The "YANA Framework" can do a lot more, but you should go and test for yourself.


Licensing
===================================

Q: "May I give 'YANA' to other people for free?"

--------------------------------------------------------------

A: Yes! As long as the package is complete, including the license and all copyright notices remain untouched. This mean you may provide it for free - you are NOT allowed to take money for it.


Q: "I have made some plugins / skins / translations with 'YANA'. May I give them to other people for free?"

--------------------------------------------------------------
A: Yes - of course!


Q: "May I sell the Framework and/or software bundled with?"
--------------------------------------------------------------

A: No. This is prohibited by the current license. If you want to use the framework for any commercial purpose you need to register and pay a fee to get another license.


Contributing
===================================

Q: "How can I contribute to the project?"
--------------------------------------------------------------

A: The first thing is easy: tell your friends and family about it. Even send them a free copy if you like.

Test the application for yourself. If you feel like you are missing an important feature, or you found something that looks like a bug, drop a note to the wishlist or the bug section.

Next: We are in desperate need for translators. There are tons of German documentation that I just can't translate all on my own - I'm already working 24/7 to get all the coding, skinning, program translations, unit-tests, API-docs, website and press stuff done, see?

Next we always can use good tutorials. That's not half as complicated as it sounds. Just write a piece of code, write down what you do and why you do it - and there you go.

However if you feel you are more a hardcore programer than a translator or writer, have a look at the code and if you feel like you could work on it, drop me a line.

Please note: when you want your mails to be read, choose a noticable subject line. I get about 80 bulk-mails each day. If I can't distinguish your mail from all the other guys selling meds, pills and all the other stuff, your mail will most possibly get lost. Put "Yana Framework" as prefix in the subject line. Or: use the contact form on this page. If you do: don't put URLs in the text of your message. Otherwise there is a risk the junk-filter might sort it out.


Q: "Where's the English documentation?"
--------------------------------------------------------------
A: There is some English API documentation on this webpage and also in the download package. However, the German part of the manual still needs to be translated to English. I would really, REALLY appreciate anybody willing to contribute. So if you feel ready to go for it, feel free to step forward and drop me a line.


Other
===================================

Q: "I got a question and it's not in the list"
--------------------------------------------------------------
A: That's what this forum is for. Just reply to this post or start a new topic.