The Code Structure - thica/ORCA-Remote GitHub Wiki
The following folders are used:
The installation folder contains the main.py source, which just initiates the main ORCA file: App.py. It further more contains a indicator file, which should only be present in the development environment: "protected". If this file is present, then the download of repository files is blocked.
The folders contains files, which are part of the genuine ORCA repository
The "actions" folder contains the action files for the startup ORCA and other standard actions
The "codesets" folder contains all pre made codesets
This folder contains all pre made definitions. It also contains the shared definitions elements and pages
This folder contains all pre made interfaces.
This folder contains language files. Each language is stored in a separate folder with name of the language.
This folder contains all pre made scripts.
This folder contains all pre made skins.
This folder contains all pre made sounds.
This is the generic wizard templates folder, It contains sub folder for each template type.
This folder contains fürther core resources of ORCA
This folder contains the fonts of ORCA
This folder contains the translation file for ITACH tower commands to ORCA actions
This folder contains some core pictures (not skin pictures) used by ORCA
This folder contains a pre selection of TV channel logos (Subset German TV)
This folder contains a large set TV channel logos
This folder contains some repository structure files for ORCA core files.
This folder will be created by ORCA and contains cookies, repositories downloads and other temporary files
This folder will be created by ORCA and contains the ORCA log files
This folder contains the wiki content files for the autocreation of thORCA wikipedia
The ORCA folder is the main folder for all source files. The root ORCA folder contain the main source files. Don't be confused: The installation folder contains the main.py source, which just initiates the main ORCA file: App.py
The actions folder contains the code for the individual actions.
The scripttemplates folder contains the the base classes for scripts. One example is the template for discover scripts.
This is reserved for future extensions
Here you can find all customized and new setting types for the ORCA settings dialogs.
A collection of standard dialogs, which are not part of a definition
A folder which contains a collection of helper files.
In this folder you can find all kind of GUI elements / widgets.
The following environment variable are used for the development environment
For the repository manager, to create the and upload the repository, the following variables are used
- set ORCAFTPSERVER=ftp.orca-remote.org : The (FTP) URl of the repository server
- set ORCAFTPSERVERPATH=/repositories/ORCA_$var(REPVERSION) : The remote FTP Server path
- set ORCAFTPUSER=FTPUSERNAME : The username to logon to the FTP server
- set ORCAFTPPW=FTPPASSWORD : The password to logon to the FTP server
- set ORCAWWWSERVERPATH=http://www.orca-remote.org/repositories/ORCA_$var(REPVERSION)/repositories : www path for the repository manager
- SET ORCAREPSOURCEPATH=$var(APPLICATIONPATH) : The (local) root path, where to find the repository
- set IRDBUSER=ITACHUSER : The control tower user
- set IRDBPASSWORD=ITACHPW : The control tower password
- set ORCAWIKIUSER=WIKIUSER : The wikipedia user
- set ORCAWIKIPW=WIKIPASSWORD : The wikipedia password
- set ORCASHOWBORDERS=1 : If set, all widgets and anchors are framed with a border.