How to reference your own grammars

1. define a publishing area on your web site, i.e. the url of the directory that contains your grammar packages; we call it base URL, defining the base directory
2. create your packages and put them in the base directory (or one of its subdirectories)
3. publish your packages by listing them in the file pckgdef.txt located in the base directory
4. That's it!

More details

1. Define a publishing area

   Register your base URL by sending an email to mconstan (at) univ-mlv.fr. The email title should be : "[graalweb] subscribe". The email body should include the following information:

   • base URL (URL)
   • personal information (NAME,SHORTNAME, ORGANIZATION, ORG_SHORTNAME, EMAIL)
   • information URL, e.g. personal or organization site (INFO)

   Example of the email body:
   URL=http://igm.univ-mlv.fr/~mconstan/library/graphs
   NAME=Matthieu Constant
   SHORTNAME=constant
   ORGANIZATION=IGM, Marne-la-Vallee, France
   ORG_SHORTNAME=igm
   EMAIL=mconstan@univ-mlv.fr
   INFO=http://igm.univ-mlv.fr/~mconstan
   

   Note: this subscription is moderated. You should be notified of your acceptance in the following days.

2. Create your grammar packages

   A grammar package is a zip file (e.g. example.zip) including :

   • the graphs of your grammar
   • a documentation in HTML, with the same name as the package followed by the html extension (cf. example.html)
   • optionally, an XML documentation, with the same name as the package followed by the xml extension (cf. XML Schema and example.xml)
   • a license (ex. GPL, LGPL, LGPLLR)
   • optionally, other files

   The XML documentation contains three types of data:

   • meta information (package name, version, license, authors, ...),
   • content information (linguistic description of package, keywords, examples of recognized expressions, list of graphs, main graphs with description),
   • list of resources needed to use grammar of the package (grammar, dictionary,lexicon-grammar table)
     For instance, grammar of package example.zip needs external resources to be used: a specific dictionary of name of tennis players and a graph (Dnumth) included in package example2.zip.

   If XML documentation is not included, your grammar package will not be indexed using the meta-information in the documentation. The GraalWeb index will not contain the information in your documentation.
   The package should be placed in the base directory (or one of its subdirectories), with the HTML documentation and optionaly the XML documentation.

   Important note: the grammar package creation can be made either manually or automatically with the use of the software PckgMaker

3. Publish your grammar packages

   Finally, you should list your packages in the mandatory file pckgdef.txt located in the base directory. You just need to list the relative path of your packages in the base directory (a package per line)

   For instance, in the example file pckgdef.txt,
   the line example1.zip indicates that the package example1.zip is located in the base directory;
   the line subdir/example2.zip indicates that the package example2.zip is located in the subdirectory subdir of the base directory.

   Ease this process by using PckgMaker