The files

We will describe here, briefly, the most important files and directories that are contained in the SVOCat installation.

You will probably want to read this at least once. In some cases just for getting an idea about what is there. But, what is more important, because you will surely need to edit a few of these files.

As a very fast summary:

index.php (the web catalogue), cs.php (the VO ConeSearch service) and admin.php (the administration page) are the most important files and the only ones that should be accessed directly as web pages. All the others are files used by any of these ones.

home.php, documentation.php, news.php and search.php implement the four main functionalities in the web page and you could want to edit some of them (news and documentation).

The style directory contains everything related to the look and feel of the web page and you can (and probably want to) change some things there.

More details:

Edit/custom			The style directory includes all the files related to the look and feel of the web page (css style sheets, images, headers, footers, etc). You will surely want to edit at least some of these files to provide some "coorporative" image to the web site.
Edit/custom			The documentation.php is a page that you must edit to include the documentation about your catalogue. It can be an html page, a series of links, you can include php code if you want... It's up to you. The docs directory is a convenient place to include documents (pdf files, images, etc) that you want to reference from the documentation.php file. The docs directory name is not harcoded anywhere in the application. This means that you can rename it, delete it if you don't need it or do what you wish with it.
Edit/custom			news.php is the content that will be loaded by index.php when a user clicks in the "News" link at the menu. If you decide to include this functionality in the configuration process you must also edit it and include the news that you want to comunicate to your users. We have styled it as a series of title/text pairs but you are free to edit it as you wish.
Edit/custom			This is in practice a placeholder just in case you want to add another custom functionality to the web page. During the configuration you can include it and define the text that will be shown in the menu for this functionality. Then you can edit other1.php and include whatever you want using html or PHP. Otherwise, if you don't need anything special, just ignore this file.
Edit/custom			This is the recommended directory where to place your catalogue files if they are in csv format (see the corresponding section). You can put the files in some other place of your computer if you want, but this directory can be a good place. In a fresh installation of SVOCat we have included here the file cmc15n2-part1.csv as an example. This is only important if you want that SVOCat helps you to populate the database starting with csv files. If you want to populate the database by your own means, you don't need this directory.
Don't touch			The admin.php is the file that allows you to configure the application and you will have to access it using a web browser as: http://www.mylab.org/catalogues/mycat/admin.php The admin directory includes files used by admin.php. You shouldn't need to edit anything in these files.
Don't touch			The config directory includes all the configuration files. They should be writen by the web server accordingly with the configuration that you give in the admin.php administrative application. Remember that this directory and the files in it must be writable by the web server. In principle you shouldn't need to touch anything here (with the only exception that you want to include extra functionalities, implemented by you, in the web page, as it will explained later).
Don't touch			If you have your catalogue data as a csv file, the administrative application will generate some scripts to help you to create a MySQL database table and load the data into it. This directory will contain these scripts created using the information that you give in the configuration. In principle, you shouldn't need to edit the scripts but you are free to do it if you need it and you know what you are doing. In a fresh installation of SVOCat this directory will include the scripts corresponding to the "Example Catalogue" and they will be changed later by the admin application. Remember that this directory and the files in it must be writable by the web server.
Don't touch			index.php is the main script for the web page. You can access it as: http://www.mylab.org/catalogues/mycat/index.php http://www.mylab.org/catalogues/mycat/ This script uses other files as needed, depending on what is requested by the user (home, search, documentation, catalogue search, etc). You shouldn't need to edit anything here.
Don't touch			cs.php is the file implementing the VO ConeSearh protocol and can be accessed as: http://www.mylab.org/catalogues/mycat/cs.php specifying the adequate parameters. Read the ConeSearch section for further explanation. You shouldn't need to touch anything in this file.
Don't touch			home.php is the content that will be loaded by index.php when a user clicks in the "Home" link at the menu. It is also the default content. In principle, this content is generated just using the configuration that you give in the admin application and you shouldn't need to edit this file. But you can edit if if you want to add something.
Don't touch			search.php is the content that will be loaded by index.php when a user clicks in the "Data Retrieval" link at the menu. It implements the catalogue search and data retrieval accordingly to the configuration given by you in the admin application. You shouldn't need to edit anything there.
Don't touch			This is a directory including files defining functions used by other files. You shouldn't edit anything here unless you really want to hack the application and you know what you are doing.
Don't touch			This directory includes javascript libraries that are used in the web page to implement several functionalities. It includes: wz_tooltip.js (by Walter Zorn) to implement tooltips explaining catalogue properties samp.js (by Mark Taylor) to implement SAMP comunication between the web page and VO tools vsamp0.js as a connector between PHP and the SAMP library. showhide.js to hide/show a certain layer at the user convenience. You shouldn't edit anything here unless you know what you are doing.
Don't touch			This files are used by the web page to be able to send catalogue search results to the Aladin application through JNLP. You shouldn't need to change anything there.