Design:ApiFusion.org/folders

From ApiFusion
Jump to: navigation, search

Project folder structure

The URL matches FS and version control unless otherwise stated.

source folders

Source on version control will match the web site URL and FS

  • /wiki mediawiki installation. Could be a git subtree with local changes commit. The local changes will be limited to symlinks and config files overrides located in another subtree. See ApiFision.org/wiki.
  • /php the service modules. See ApiFision.org/php.
  • /phpwiki mediawiki add-ons and overrides. Location will map to ../wiki FS. Wiki overrides own by ../wiki are kept here as a link for AF docs reason. The files which are not a part of original wiki held in phpwiki served by TBD( 404 handler or symlink within /wiki ). See ApiFision.org/phpwiki.
  • /ns is a root for all namespaces URL mapping. The application will refer individual doc pages here. The /ns/Default matches wiki default namespace.

404 error handler for /ns root encapsulate request to wiki with matching URL into XML with associated XSLT. The assembled XML will be used for data caching into file matching the original URL. ".xml" extension will be added to each file to distinct subpages and avoid mimetype collision.
See ApiFision.org/ns. VC

AmdHarness.org UI app convention is in place for JS structure:

  • app subtree the project ApiFusion.org/app
  • lib the root for UI projects in format organization/module
  • lib/Appfusion.org holds project ApiFusion.org/UI which owns few others.