FarCry Documentation Exports
November 22 2009, 2:33 PM
We've been going through a rethink on how FarCry documentation should
be done. We're finding that, while there is heaps of documentation,
people are having a hard time finding specific solutions. We're
really proud of the documentation on http://docs.farcrycms.org/, but
realise it doesn't help finding, say, what "wizardID" is on
; what it's supposed to do, or that it is even there. FarCry has an extensive ability to do inline documentation within the
code, and we've started to try to pull that out and harness it a bit
better. The goal is to get up to date, easy to grep help for FarCry
as close to your code writing as possible (and searchable via
google++). Additionally, we are working towards smaller, example
focused bits. We've allocated "daemon time" to try to get a base documentation
project up, and we have http://docs.farcrycore.org/ in a very, very
beta state (looks horrible too). However, we'd like to get some
feedback on it's content. Additionally, the CFEclipse dictionary,
and the textmate bundle are generated along side the documentation so
they should auto improve as the documentation improves. The main page has links to 6 versions of FarCry. p510 is FarCry 5.1.0
documentation, p520 is the head of 5.2.x branch of FarCry (not
officially released but mostly stable), and trunk is the main line
development for the next major release ie. 5.3 codenamed "Formality"
(for all you bleeding edgers). The top 3 links are documentation of the base of FarCry - Tags, Types,
and Components. This is the bare core without any plugins. The bottom
3 links are documentation of FarCry with the CMS plugin installed -
Tags, Types, and Components. They are only offered as downloadable
zips at this time. Some important things to note - Deprecated items are not currently being marked as such. This will
happen as time allows.
- The documentation itself is a bit sparse still. We need to get more
documentation actually typed into the code - patches welcome :-D
- The Components tree is all Grey because nothing is currently marked
as an documented (though most of it is). See "fapi" or "fu" for a
good list of things you'll likely want to know. The "scope" part of
the Components is very helpful - thats where you can find the method
at runtime (if it's auto created).
- We don't have any plans to back port this to earlier versions Enjoy! PS. Many thanks to Rob for his automated builder magic, and Blair for
his doco parsing skills
be done. We're finding that, while there is heaps of documentation,
people are having a hard time finding specific solutions. We're
really proud of the documentation on http://docs.farcrycms.org/, but
realise it doesn't help finding, say, what "wizardID" is on
; what it's supposed to do, or that it is even there. FarCry has an extensive ability to do inline documentation within the
code, and we've started to try to pull that out and harness it a bit
better. The goal is to get up to date, easy to grep help for FarCry
as close to your code writing as possible (and searchable via
google++). Additionally, we are working towards smaller, example
focused bits. We've allocated "daemon time" to try to get a base documentation
project up, and we have http://docs.farcrycore.org/ in a very, very
beta state (looks horrible too). However, we'd like to get some
feedback on it's content. Additionally, the CFEclipse dictionary,
and the textmate bundle are generated along side the documentation so
they should auto improve as the documentation improves. The main page has links to 6 versions of FarCry. p510 is FarCry 5.1.0
documentation, p520 is the head of 5.2.x branch of FarCry (not
officially released but mostly stable), and trunk is the main line
development for the next major release ie. 5.3 codenamed "Formality"
(for all you bleeding edgers). The top 3 links are documentation of the base of FarCry - Tags, Types,
and Components. This is the bare core without any plugins. The bottom
3 links are documentation of FarCry with the CMS plugin installed -
Tags, Types, and Components. They are only offered as downloadable
zips at this time. Some important things to note - Deprecated items are not currently being marked as such. This will
happen as time allows.
- The documentation itself is a bit sparse still. We need to get more
documentation actually typed into the code - patches welcome :-D
- The Components tree is all Grey because nothing is currently marked
as an documented (though most of it is). See "fapi" or "fu" for a
good list of things you'll likely want to know. The "scope" part of
the Components is very helpful - thats where you can find the method
at runtime (if it's auto created).
- We don't have any plans to back port this to earlier versions Enjoy! PS. Many thanks to Rob for his automated builder magic, and Blair for
his doco parsing skills