The followings are guidelines on how to browse GAMS Documentation and Model Libraries.
Two main categories available for browsing are Documentation and Model Libaries.
Use the Back and Forward functions in the browser to navigate the history of viewed topics, and click on Documentation or on Model Libaries to restart browsing topics from the main pages.
Searching for contents is availble for both Documentation and Model Libaries. Two different version of search are Searching for Online Contents and Search for Offline Contents. Both version is accessible by clicking on search in the top right area of the page. Unless specifying otherwise, the Documentation will be searched by default.
Searching for online contents is accessible via online search.
Follows the following search expression rules to search the online contents:
GAMSreturns topics that contain gams, Gams, GaMs, and GAMS.
createreturns hits on topics that contain create but not creates, creating, creator, and so on.
? and multiple characters using *. For example, the keyword: ga?returns hits on topics that contain gap and gas but not gams.
ga*returns hits on topics that contain gap, gas, gams, gamma, gamsworkspace, and so on.
objective functionreturns topics that contain both objective and function, but does not return topics that contain only one of these words.
objective AND functionreturns topics that contain both objective and function, but does not return topics that contain only one of these words.
objective OR functionreturns topics that contain either objective or function.
objective NOT functionreturns topics that contain the word objective but exclude the word function.
+objective functionreturns topics that must contain the word objective but may contain function.
-objective functionreturns topics that exclude the word objective but contian the word function.
a, able, about, across, after, all, almost, also, am, among, an, and, any, are, as, at, be, because, been, but, by, can, cannot, could, dear, did, do, does, either, else, ever, every, for, from, get, got, had, has, have, he, her, hers, him, his, how, however, i, if, in, into, is, it, its, just, least, let, like, likely, may, me, might, most, must, my, neither, no, nor, not, of, off, often, on, only, or, other, our, own, rather, said, say, says, she, should, since, so, some, than, that, the, their, them, then, there, these, they, this, tis, to, too, twas, us, wants, was, we, were, what, when, where, which, while, who, whom, why, will, with, would, yet, you, your
Searching for offline contents is available as a part of GAMS distribution documentation.
When the search term has a prefx match to the index (See also Browsing Index for Known Keywords), the search result suggests the list of related keywords allow to access the contents directly using the known keyword.
Follows the following search expression rules to search the offline contents:
GAMSreturns topics that contain gams, Gams, GaMs, and GAMS.
createit will return hits on topics that contain creates, creating, creator, and so on.
objective functionreturns topics that contain the word objective and the word function, but does not return topics that contain only one of these words.
a, able, about, across, after, all, almost, also, am, among, an, and, any, are, as, at, be, because, been, but, by, can, cannot, could, dear, did, do, does, either, else, ever, every, for, from, get, got, had, has, have, he, her, hers, him, his, how, however, i, if, in, into, is, it, its, just, least, let, like, likely, may, me, might, most, must, my, neither, no, nor, not, of, off, often, on, only, or, other, our, own, rather, said, say, says, she, should, since, so, some, than, that, the, their, them, then, there, these, they, this, tis, to, too, twas, us, wants, was, we, were, what, when, where, which, while, who, whom, why, will, with, would, yet, you, your
To search within one document page for a specific word or phrase, use Find... (for example, CTRL+F) function in the browser.
The Index page provides a convenient way to access specific locations in the documentation through a list of interesting keywords. Note that only GAMS Documentation pages are indexed and not all sections contain an index, e.g., there is no index for model libraries.
To browse Index page for known keywords:
Clicking on a printer-friendly verion at the bottom left of the page to reload the contents of the same page without styles and without the table of contents for navigation.
It is also possible to append a string after the url of the page in the browser navigation bar and use the browser reload function. The string is one of the followings:
?print=1 - get the page contents without styles and without the table of contents for navigation?print=2 - get the page contents with styles but without the table of contents for navigationThe syntax used to introduce features in the various chapters are presented using a format inspired by the Backus-Naur form (BNF) notation where:
| Notation | Description |
|---|---|
[] | the enclosed construct is optional |
{} | the enclosed construct may be repeated zero or more times |
¦ | there is an or operator across the arguments on both sides of the symbol |