ernad documentation

Thomas Krichel and Roman D. Shapiro

2005-06-18

amf/ has a link to the AMF data that ernad is looking at for document data.

doc/ contains ernad documentation in HTML format.

etc/ contains the configuration files
etc/apache has apache2 configuration files for the web server that is owned by the user ernad.
etc/ernad.conf has the system configuration.
etc/reports.amf.xml has the reports configuration.

html/ contains HTML files that are required by the system.
html/no_issues.html says that there are no issues for the editor to edit.
html/no_more_issues.html says that the same thing after the editors has worked to finish an issue.

perl/ contains the Perl scripts and modules.
perl/Ernad contains the Perl modules.
perl/Ernad/Checking.pm implements pre-datebase,post-datebase and check_futli functionality.
perl/Ernad/Common.pm has common functions.
perl/Ernad/Contants.pm contains constants like directory or file names.
perl/Ernad/Dates.pm has functions to work with dates.
perl/Ernad/Final.pm has functions to work and generate the html/text/send stage.
perl/Ernad/Generate.pm has functions for generating the allport issue.
perl/Ernad/Globals.pm contains functions for the startup. It is called when the main apache starts up.
perl/Ernad/Issue.pm contains functions for the issue selection process.
perl/Ernad/Login.pm contains functions for the login to the system. This is the first module that is activated when a user connects.
perl/Ernad/Main.pl is the main module that determines the current state and calls other modules.
perl/Ernad/Papers.pm contains functions for the paper selection stage.
perl/Ernad/ReportState.pm contains functions for sorting, select, deleting papers in issues.
perl/Ernad/Sorting.pm contains functions for sorting papers in issues.
perl/delete_old_reports is a utility that deletes all reports with a certain date, yyyy-mm-dd. The date has to be given as date thus delete_old_reports.pl 2005-02-29
perl/index.pl is the file that is run where there is a connection to the ernad site.
perl/list_reports.pl is a utility that lists all reports.
perl/make_all.pl is run at the command line by the general editor to make the allport issue.
perl/n.pl is the download script. It is called as n in the browser, therefore we have a soft link n to it.
perl/presorting.pl creates the presorted report.
perl/processreports.pl creates directories that are required by the report. It has to be run every time a new report is added in reports.amf.xml.
perl/startup_for_download.pl is the mod_perl startup file for the apache server that serves fulltext downloads.
perl/startup_for_main.pl is the mod_perl startup file for the main ernad server, i.e., the one owned by the user ernad.

var/ has the output of the system
var/db/ has databases.
var/db/futli_base.dump is a Perl dump of the futli base.
var/db/papers_dates.dump is a Perl dump of the date base.
var/db/reports has the data files for all reports.

Valid XHTML 1.0!