RefGuide Introduction

 

Overview

The Analytic Information Server Reference Guide Document Manager agect acts as a semi-intelligent document manager Lambda which is able to generate cross referenced and cross indexed HTML documents in the specified input(Foundry) and output folder(wwwroot).

The following are the list of folders in RefGuide:

Foundry: This is the specified input folder. This folder contains the files the user needs to generate the HTML Documents. The file contents of the Foundry folder are evaluated by the program aisRefGuide to generate the output.

wwwroot: This folder contains the output of the aisRefGuide program. The ouput are cross referenced and cross indexed HTML Documents. These ouput files are saved in the output folder wwwroot.

CoreContent: This contains all the input files needed to generated the AIS Documentation.

Templates: This contains the Templates for the output HTML Pages. Each Ontology Object has a different Template.

Bin: The aisRefGuide Database file is store in this folder.

Source: This contains the aisRefGuide source code saved as an LambdaBase file (*.sl).

To generate the AIS Documentation, copy and paste all the files in CoreContent and Templates to the Foundry folder. These files in the Foundry folder will be the files evaluated by aisRefGuide.

Ontologies

An ontology is a description of the concepts and relationships that can exist for an Lambda or a community of Lambdas. The aisRefGuide main Lambda and its other child Lambdas operate on a defined set of Ontology Objects. These Ontology Objects specify a specific knowledge grouping used in AIS. These knowledge groupings represented as Ontology Objects (or Ontologies) are as follows:

Document Ontologies: These contain a list of Essay Ontologies. A Document Ontology defines the structure of an AIS Document.

See an example of a Document Ontology.

Essay Ontologies: These contain paragraphs, tables and images that relate to a specifiec topic not classfied by any other Ontology.

See an example of an Essay Ontology.

Datatype Ontologies: These have informatation on the different Datatypes used in AIS programming.

See an example of a Datatype Ontology.

Function Ontologies: These contain information on AIS Functions. Function Information mainly includes Syntax and Usage.

See an example of a Function Ontology.

Example Ontologies: These represent Source Code Examples to illustrate AIS Functions.

See an example of an Example Ontology.

VMInstruction: These contain information in AIS Virtual Machine Instructions. Like Function Ontologies, VMInstruction Ontologies mainly include Syntax and Usage.

See an example of a VMInstruction Ontology .

Note: Ontology attributes represented in XML are used to cross reference and cross index AIS Ontologies.