Dataface Flow Charts posted online

A place for users and developers of the Xataface to discuss and receive support.

Postby Aoirthoir » Fri Sep 15, 2006 10:36 pm

Ok I bought a windows program to create flow charts. I like the format. Not everything I wanted, but pretty close. So I flow charted the entire Dataface application and API libraries. At least I think I did. If anyone notices anything missing please msg me here or at boscagarda-programming@yahoo.com and I will try to correct it.

You can find some very basic links here: http://www.dataface-base.com/ for now. As other versions of Dataface come out I will update the flow charts for them as well.

Currently I do not have this in any fancy format. Visustin allows you to create flow charts in the following formats:
.bmp - Bitmap
.gif - Um, gif
.jpg - Um, jpeg
.png - Ping I guess :D
.ps - Postscript (yall might have known that but I would not have)
.wmf - Windows Metafile (some kind of vector format)
.emf - Enhanced Metafile (again vector?)
.vsd/.vdx - Visio 2002/2003 if you have Visio installed. (I do not)
.txt - Visio 2002 import files (same as above)
.dot - Dont know what this is.
.mht - Web Archive
.htm/gif - HTML with Gif files
.htm/png - HTML with PNG files.

I used the HTML with PNG files. A caveat, some of these flowcharts are EXTREMELY large, so they cannot be seen in the web browser (at least in firefox) at all. They appear just as a big black stripe. However you should be able to view them in a graphics program. I've been able to do so. I chose png because I believe it is portable. I would have prefered some kind of vector format, but I dont think everyone can read wmf files. So I skipped that for now. Maybe the program will be updated to use SVG. I will bring it up to him if someone reminds me in the future.

Now another caveat. It is late (1:25am) and I am exhausted. So I didnt make web pages for any of these things. I just tarred up the directory structure and loaded it on my server then untarred it. But you should be able to go through it in your web browser. If you cannot see an individual png because it is too large, you can download it. I will try tomorrow to tar them all up into one file so that yall can download all the pngs.

As to the structure I used, was this. I recreated the Dataface directory tree. Then I placed each png and html file into that tree in the same manner the .php files already existed. Thus if there is /dataface/test/aoirthoir.php there will now be /dataface/test/aoirthoir.png and .html. But other than those two files this is an empty directory tree. So there are a lot of folders there that are empty. Later on, I will try to create links to just active files. Or if someone already has software that will recurse a tree structure and make html links for html files, let me know if you are willing and I will send you the tar file. (Or I will zip it, whatever format you need.)

I am also willing to flowchart code that anyone has. Let me know.

My goal in doing this is to make the dataface code more understandable to us all, so that we may begin to participate in its developement. I do not know if these flowcharts will accomplish that, but I hope so.

Lastly, while currently not displayed they are copyright by me, Joseph James Frantz. I am going to let them go under a creative commons or gpl license. Basically use them for whatever you want, give me credit, and give others those same rights I just gave you. Modify to your hearts content etc. Commerical use is allowed..again under the same conditions. I will formalize the rights statement sometime this weekend.

Any suggestions or comments are welcome here or at above email address.

Thank you kindly.
Aoirthoir
 
Posts: 420
Joined: Wed Dec 31, 1969 5:00 pm

Postby Aoirthoir » Fri Sep 15, 2006 10:40 pm

Also I used the largest form of flow chart Visustin has. Some time soon I will step by step make some of them smaller. This will give you an overall view of the flow of a program but not show all of the code, as the current flowcharts do. So there are four levels, all the way from minimal code view, to view all code. Also 3 views of the comments. Thus eventually I will have 7 flowcharts for each .php file. You can choose which ones you wish under any needed circumstance.

Thank you kindly.
Aoirthoir
 
Posts: 420
Joined: Wed Dec 31, 1969 5:00 pm

Postby Aoirthoir » Sat Sep 16, 2006 1:18 am

Well I was at work when I sent the above messages. Shortly after I got home I decided to check out if I could just use the tree command and do some search/replace functions. Well as it turns out tree will output html. I still had to fiddle with it a little bit because the lines didnt line up. But it is all there now. Click on the link above and you will see the link for the flow charts. That will give you the entire dataface tree structure for php files only. Of course they are now listed as html and png files for the conversion to flow charts. Hope yall like it. Any questions just give me a buzz..Now I think I really am going to go to bed.
Aoirthoir
 
Posts: 420
Joined: Wed Dec 31, 1969 5:00 pm

Postby shannah » Sat Sep 16, 2006 1:24 am

Those docs that you generated are fantastic! That program really does a good job of this stuff. Hopefully it will help others to get into the code base more easily.
--
Steve Hannah
@shannah78 (on twitter)
sjhannah.com blog
shannah
 
Posts: 4457
Joined: Wed Dec 31, 1969 5:00 pm


Return to Xataface Users

Who is online

Users browsing this forum: No registered users and 33 guests

cron
Powered by Dataface
© 2005-2007 Steve Hannah All rights reserved