FarCry Documentation Plugin (farcrydoc)

Overview

FarCry Documentation plugin provides extensive documentation on framework, plugin and project based components. An awesome utility for FarCry developers that dynamically introspects your installation to extract oodles of information.

Download

You can grab the latest code base from the FarCry subversion repository:

• v1.0.x (suitable for FarCry v5.x+) Download or *svn checkout checkout https://farcry.jira.com/svn/DOC/tags/milestone-1-0-0*
• trunk (under develoment, suitable for FarCry 6.x) *svn checkout https://farcry.jira.com/svn/DOC/trunk)*

Installation

5,0,x Installation

Update the plugin list in your project's ./www/farcryConstructor.cfm file.

<!--- FARCRY SPECIFIC --->
<cfset THIS.locales = "en_AU,en_US" />
<cfset THIS.dsn = "fullasagoog" /> 
<cfset THIS.dbType = "mssql" /> 
<cfset THIS.dbOwner = "dbo." /> 
<cfset THIS.plugins = "farcryblog,farcrycfimage,farcryverity,farcrydoc" /> 

4,0,x Installation

Add farcryverity to your plugin list in the farcryinit tag of your project's Application.cfm:

<farcry:farcryInit
  name="daemon"
  dbType="mssql"
  plugins="farcrycms,farcryverity,googleMaps" />

Configuration

Then you need to configure the Verity collection storage path and hosts to be managed in your _serverSpecific Vars.cfm configuration file:

<cfsetting enablecfoutputonly="true" />
<!--- setup environment variables for specific developers/machines/servers --->
<cfset machineName = createObject("java", "java.net.InetAddress").localhost.getHostName() />

<!--------------------------------------------
PRODUCTION ENVIRONMENT
--------------------------------------------->
<!--- set verity plugin config --->
<cfset application.stplugins.farcryverity.storagePath="C:\Inetpub\verity\collections" />
<cfset application.stplugins.farcryverity.lhosts = machinename />

<cfsetting enablecfoutputonly="false" />

Then simply reinitialise your application and login to the webtop. You'll find the administration screens under: ADMIN > Verity Plugin

Content Types

farVerityConfig
farVerityLog

Release Notes

You can track changes to the FarCry Verity plugin code base here: http://fisheye.farcrycms.org/browse/plugins/farcryverity

Issues