--- /dev/null
+<html>
+<head>
+<title>Search Engine Interface Online Manual</title>
+</head>
+<body>
+<h2>Index</h2>
+1. <a href="#roles">Roles of the frames</a><br>
+2. <a href="#mqlquery">How to compose a low-level query</a><br>
+3. <a href="#pdqquery">How to compose a pre-defined query</a><br>
+<a name="roles"><h2>1. Roles of the frames</h2></a>
+<p>
+The interface is composed by five frames, as you can see below.<br><br>
+<img src="./frames.jpg"><br><br>
+Each frame has its own role, in particular:<br><ul>
+<li>frame <b>1</b> contains the query as it is, the frame is refreshed whenever you modify the query.<br>
+<li>frame <b>2</b> contains all the available options for the composition of the query, it's where most of the interaction happens.<br>
+<li>frame <b>3</b> contains the form used for the submission of the query and various buttons to modify it.<br>
+<li>frame <b>4</b> contains the grammar.<br>
+<li>frame <b>5</b> contains online help.<br>
+</ul>
+</p>
+<a name="#mqlquery"><h2>2. How to compose a low-level query</h2></a>
+<p>
+In order to compose a low-level query, you must click the "compose a query" button in the main page. Here's what you'll get:<br> <ul><li>In frame 1, you have the query in its actual state, so at the beginning the frame is empty. Later, the frame will be updated automatically on every change of the query and will contain hypertextual links in this form: <b>[?<production name><production number>]</b>. Possible names are "set","val" and "bol" and they represent the main productions of MathQL grammar. By clicking on each of these links you'll obtain the visualization of possible options for the corresponding production in frame 2, allowing the sobstitution of the link with what will be selected.<br> <li>Frame 2 contains, in order: the identifier of the production you are choosing (e.g. <b>[?set1]</b> or <b>[?bol3]</b>), an "undo" button, a "redo" button, the options list, a "compose" button to confirm your choice, a "get help" button to know the semantic meaning of the selected option. The options list is composed by various radio buttons, sometimes you'll have only to select one of them while sometimes you'll have to fill input areas with identifiers, paths or other things: anyway, whenever an input area gets the focus, a help about what you can write there will appear in frame 5.<br>
+<li>Frame 3 contains a textarea with the query, a "submit the query" button, a "restart" button (it will bring you to the main page, erasing you query) and an "apply changes" button to modify the query. <br><li> Frame 4 contains the MathQL grammar.<br> <li>Frame 5 contains various help messages, whenever an object gets the focus a message will appear there.<br></ul>
+Being "set" the main production of MathQL, at the beginning frame 1 is empty and frame 2 contains the menu for "set". You should choose one option by clicking on its radio button and then press "compose". The interface will perform a syntax check of what you entered and should something be wrong a message will appear, otherwise the query will be updated. Afterwards, the query will appear in frame 1 and in frame 3, and frame 2 will display the menu of the first production found in the new query string. For example, in the picture below you see the interface after the selection of the 10th production inserting "positions" as the requested identifier. As you can see, frame 2 now displays the "val" menu.<br><br>
+<img src="./ex1.jpg"><br><br>
+Now your options include following the instructions in frame 2, choosing a different production by clicking on a link in frame 1, or manually modifying the query by writing the changes in the textarea in frame 3 and then clicking "apply changes". Obviously "undo" and "redo" buttons will allow you to recover from mistakes; just DON'T use "back","forward" and "refresh" buttons on your browser since they will cause unpredictable errors. Once the query is completed, the "submit the query" button will display the results in frame 2.</p>
+<a name="#pdqquery"><h2>3. How to compose a pre-defined query</h2></a>
+<p>
+There are actually three pre-defined queries, <b>Locate Object</b>, <b>Search Pattern</b> and <b>Match Conclusion</b>. By clicking on "submit a pre-defined query" in the main page, a small menu with the three options will appear in frame 2. <br>
+<b>Locate Object</b> is very simple, you must enter the name of the object to search in the text box and click "display results".<br>
+<b>Search Pattern</b>, which takes a CIC term and finds theorems which have it as thesis, and <b>Match Conclusion</b> which takes a CIC term and finds theorems which have it as conclusion, have an identical interface, being the only difference in the output.
+First thing to do is to insert a list of aliases (you may skip this step since the search engine will ask you later about ambiguous interpretations of your query if you don't know objects names, for example), then you must compose the CIC term. Composing a CIC term is pretty much the same thing as composing a MathQL query, except that the term is usually so short that there is no need for links, undo buttons and the like. While composing the term, you may modify your list of aliases (i.e. add or remove them) anytime by clicking "edit" in the frame 3. When the query is completed, the "submit" button will display the results in frame 2, and the server will ask you to solve ambiguities, thus adding aliases to your list. Once a result is displayed, you may want to submit a different query but keep your aliases; in this case, just click "new expression" in frame 3. The "edit" button will work even in this phase.<br><br>
+<img src="./alias.jpg"><br><br>
+</p>
+
+</body>
+</html>
\ No newline at end of file
projects / helm.git / commitdiff
