Dataface Documentation Project

[Aoirthoir]

Ok I have started the basics of the project. Ive gone through the dataface website and put together all of the links I could find. I have them listed here:

http://framework.weblite.ca/Members/Aoirthoir/dataface-bookmarks/view

So if anyone can go through it and find anything that I have missed and message me about it, that would help. I will start to organize it, but I also have to go through the forums and see what we come up with out of those.

Thank you kindly

[Aoirthoir]

Now that that is mostly done, I would like to start with a Dataface Users Guide. As I've mentioned, some of the chapters might just be pointers to another place already on the website. Or it might all be contained within the Users Guide itself. Particularly if output to PDF or a tarred HTML setup.

So if anyone has any ideas on what we would like to see in the Users Guide please let me know.

[Aoirthoir]

Ok not much has gotten done this weekend. Had too much to do with the cats and back and forth to the store to buy stuff...so ima hopin I have some energy right now...Gonna go through the forum and see what we come up with.

[dwe]

As a very 'new' user of this software, i was kinda surprised how easy it was to adapt the basic tutorial to my needs.
However a couple of questions remained (like the one i`ve posted).

The 'Widget'-tutorial is great, since it covers all basic aspects one gets in touch with while developing an dataface application.

But when creating a 'customized' application from scratch, there may be a couple of questions
(eg. Why is alway the first non-linked column of a table used as input for the drop-down-select in view-mode?).

I think a 'create a customized dataface application' guide would be very helpfull.

The steps I`ve used are:

1. create the database scheme.
Two approaches are possible:
- implementing an already existing scheme
- using phpmyadmin or other tools and dataface as rapid-development tool to create it on the fly


2/3. create a basic frontend
- implement appropiate widgettypes, add validation

3/2. normalize the database and link the tables
- create/alter new/existing tables to be used for vocabularys
- add realtions for the tables and test them

4. rework frontend
- add /recheck validation
- add labels, group widgets etc.

5. implement permissions

6. rework styles
- change 'view', 'edit' and database list output

7. rework navigation
- still have to figure this out

[dwe]

Sorry, delete the second post and this one, plz.
Dont`t know how that happend - just wanted to correct a spelling mistake...

[Aoirthoir]

Thanks for the input DWE. Perhaps the "Customized Dataface Application" can be a part of the main Users Guide. Or it could be a seperate manual.

Basically we have the layout needed...its a matter of creating the table of contents and then copying/pasting Mr. Steve's docs to that structure.

I think the layout you gave above is excellent. I will have to work on it next week. This weekend I had hoped to get a bunch done, but had a personal issue, then had to take care of my cats. So I am exhausted still.

But going to try to go through and lay out the table of contents. Your suggestions will greatly help. If anyone else has any ideas please post them. I want this to be a manual, not just for me, but for everyone.

Thanks

[Aoirthoir]

ok over the weekend not much got done. Had a couple personal things come up and then had to care for my cats, do some spring cleaning and all that good stuff.

So now I would like to move this forward. I am looking for any ideas or suggestions for the Dataface documentation. Here though are my goals.

1. Document every built in Dataface feature.

2. Document how to use the templates to modify a Dataface App. (with Examples)

3. Document fully the extensibility of Dataface with its triggers, API etc. (With Examples)

4. Create fully running example databases and apps for people to play around with and learn from. With LOTS of data. This will be online and downloadable through SQL dumps.

5. Create various Dataface manuals, users guides etc. The data of which should be all be downloadable in various formats. (PDF, HTML, SQL etc.)

Soooooo I will try to get to it tonight. Above I have links to everything I could find on the Dataface website except the forums. If anyone has seen any links I dont have please let me know...Any suggestions, holler.

Thanks

[Aoirthoir]

DWE has added a HOWTO of his own. I have linked to it in the above documentation links.