SVOCat Documentation

Version 2.01, October 2020, author: Carlos Rodrigo

1. Introduction
2. Download
    2.1. Extract
    2.2. Permissions
3. The files
4. Example
5. Configure
    5.1. First
    5.2. Project
    5.3. Mysql
    5.4. Web
    5.5. VO options
    5.6. Fields
    5.7. Photometry
    5.8. Search Opts.
    5.9. File Paths
    5.10. Scripts
    5.11. Registry
    5.12. Spectra
    5.13. Links
    5.14. References
6. Web Design
    6.1. style.css
    6.2. Colors
    6.3. header.php
    6.4. footer.php
7. Extra tips
Previous   Next


[First][Project][Mysql][Web][VO options][Fields][Photometry][Search Opts.][File Paths][Scripts][Registry][Spectra][Links][References]

WEB page texts

In order to generate the web page for your catalogue some information is needed about it.

In these images we show you where these texts will be used in the web page so that you have a better idea of what you want to put there.

  • 'Title' will be used in the top header of all pages, but also as a title in the homepage.
  • 'Subtitle' will be used in the top header of all pages, but also as part of the title in the homepage.
  • 'Email' must be a valid e-mail address and will be used as the Help-Desk email contact.
  • 'Description' will be used as the first part of the home page, describing the project.
  • 'Acknowledge' will be used as the last part of the home page, below the list of resources. It is typically used to include acknowledgments, and hence its name, but you can write there whatever you want.

You can include html in these fields.

WEB functionalities/menu

In fact, as you see in the image above, SVOCat will generate not only a search form so that people can see your data but a simple web portal to offer more information about it. That's why a menu is included and you can configure which items you want to show in the menu and, thus, which functionalities you want to offer.

The currently available options are:

  • 'Data Retrieval': it is the main functionality here. It creates a web form to search for data in the catalogue and displays the data corresponding to the search criteria allowing to visualize them, download them or send them to other VO applications. This is implemented in the search.php, that you should not edit.
  • 'News': this should be a page showing news that you want to communicate to your users. We haven't done anything smart here. It is just a HTML/PHP file (news.php) that you must edit to include the news.
  • 'Documentation': should be a web page showing the documentation about your catalogue. It is also a HTML/PHP file (documentation.php) that you must edit to include the documentation, as html, as links to pdf documents or in the way you wish.
  • 'Coverage Map': this will give access to the coverage map that you can generate to offer information about the catalogue sky coverage.
  • 'Credits': this link will provide a list of credits for the catalogue. It will include the text configured as 'Acknowledge' above but it could include more information that will be configured in the 'Reference' section later.
  • 'Help-desk': this is a link to send an email to the email address that you have specified in the previous form.
  • The "Other (1)" option is a placeholder just in case you want to program some extra functionality yourself and add it easily to the menu. For instance, you could just set "Team pictures" as the Menu Title here and include the team pictures editing the other1.php file. If you want more extra functionalities read the Advanced section of this documentation.

What you must do here is:

  • You must check each item that you want to offer (on uncheck it if you don't want it). I would say that this application does not make sense if you don't check the "Data Retrieval" functionality, but you can uncheck it also if you want.
  • In the 'Menu Title' field you can write an alternative text to name the link that will be offered in the menu. For instance, you could rename "Data Retrieval" as "Catalogue Search" and this will be the text shown in the menu. If you don't write an alternative text, the one shown in the "Functionality" column will be used for the menu. Be careful about changing this because long titles could be very ugly in the menu. And please, don't use html here or you could get terrible results.

Coverage Map

One of the available options above is including a "Coverage Map" page.

A coverage map gives a fast idea of what area of the sky is covered by your catalogue, both to VO applications and to final users (if you make a simple image displaying the coverage).

SVOCat does not help to generate the coverage map, you must do it by yourself. It only provides a simple way to display these files once you have generated them.

In order to do this you must first generate a MOC fits file. You must generate it by yourself (using, for instance, STILTS) and just write here where the location of your MOC file.

You can also generate some images displaying the coverage in a user friendly way so that we can show these images in the web page.

SVOCat expects that you provide:

  • 'MOC file': Relative path to the fits file containing the MOC generated by stilts. A typical value could be "coverage/moc.fits"
  • 'MOC resolution': A free text to display what resolution you have used to generate the MOC file. For instance, it could be something like "3.665° (max order=4)"
  • 'Image (AITOFF)': Relative path to the image with a AITOFF projection of your coverage map. A typical value could be "coverage/aitoff.png"
  • 'Image (xy)': Relative path to the image with a Cartesian projection of your coverage map. A typical value could be "coverage/xy.png"

A SVOCat installation includes a folder named "coverage" as a convenient place to store these files. But you can decide to put them wherever you want.

The information provided in the configuration will be automatically used to generate the "Coverage" web page, as follows:

WEB logos

You can finally configure what logos to show in the top right corner of the web page.

We have configured this example to show our logos, but you can use your own/s.

Previous   Next