Print

[vuud]

UPDATE:  I have removed the pdf as it is replaced by newer online docs:
http://cpmfetch.fistfullofcode.com/docs/stable_basic/index.html




Hello all,

I have put together a PDF of my first draft of a simplified "get to know CpmFetch" document. 

This is intended to be the beginning of the new documentation.    The goal of it is to get someone up and running and prepare them to read the reference documentation for further learning.

I am starting on the reference doc's, but would like to automatically generate them - if anyone has good phpDocumentor experience, please contact me!  I could use some advice to save me the trial and error thing.

Anyway, the goals of this documentation is to:

* Help guide the download and install

* Provide an understanding of how to basically use CpmFetch

* Provide a basic understanding of how to interact with CpmFetch

* Provide an understanding of how to read the function documentation - which is coming later

I am hoping for feedback and such.   Places that are not clear, places that could be better explained, stuff I forgot.

See the attached PDF

Thanks,

Vuud

PS. If you are moving to the dev release, this is also the best explanation on how to do it.

[vuud]

Any ideas for tutorials and such are welcome also

[vuud]

Reminder:  THIS DOCUMENT IS FOR THE DEV VERSION ONLY 1.9.x... 

It does not work for 1.6.x or before.

[vuud]

I've decided to abandon the docbook format used for cpmfetch 1.4 and 1.6.  It's too hard to maintain.   To do it right requires a lot of updating each time I make a change.  I have neither the time, nor the inclination to work on documentation.

Instead I am going to move completely to PHPDoc, which is generally a programming reference generator.  Since CpmFetch is kind of like that I have decided to do this.  This allows me to document right inside my program and have it automagically generate into a readable format, but tends to be more reference like than manually created documentation.

The reference attached to the original post here will form what will be the ONLY full tutorial for CpmFetch.  There will be examples, but the concepts inside that will need to be completely understood.

So ANY thoughts, comments, etc... are pleaded for. 

I am giving credit to contributors of ideas, code, documentation corrections, etc on my web site if anyone seeks to boost their online presence (links to web sites too).

Thanks

Vuud

[nickfzx]

i like the pdf format as it is very easy to read and navigate through...I agree that abandoning the web based docbook is a good idea.

[vuud]

i like the pdf format as it is very easy to read and navigate through...I agree that abandoning the web based docbook is a good idea.

Well, the existing pdf will also be going away and that stuff (hopefully) be included in the phpdoc's

The PhpDoc program does have an option to create a pdf, which when I tried it:

1) Churned much longer
2) Generated lots of output
3) Created an unreadable pdf

So maybe we will have one... maybe not.

I do agree it is more readable from a tutorial point of view, so I will ensure that something easy to print and read remains

Thanks for the input!

[vuud]

The documentation proposed here has been merged into the phpdocs

It can be found at:

http://cpmfetch.fistfullofcode.com/docs/stable_basic/index.html

Its a work in progress...

Again: IF ANYONE IS PROFICENT WITH PHPDOCUMENTOR, PLEASE LET ME KNOW....  I HAVE SOME ISSUES THAT COULD PROBABLY BE EASILY RESOLVED BY SOMEONE WHO KNOWS IT WELL.

Thanks!