{
    /*  refreshCacheOnLoad:
    *
    *  Setting this to false means the plugin will need to do a callout
    *      to retrieve the Salesforce Reference Index from Salesforce
    *     when the *Salesforce Reference* command is first run.
    *
    *      When set to true (RECOMMENDED, and the default setting), the
    *      plugin will cache the Reference Index when Sublime Text starts
    *      or the plugin is reloaded
    */
    "refreshCacheOnLoad": true,

    /**
     *  docTypes:
     *
     *  Each docType has one option:
     *   - refreshCacheOnLoad:
     *       if the top-level refreshCacheOnLoad setting is true, and this
     *       docType's refreshCacheOnLoad setting is true - this documentation
     *       type will be cache when sublime starts up. Otherwise, this
     *       documentation type will only be retrieved and cached when it's
     *       corresponding command is run
     *   - excludeFromAllDocumentationCommand:
     *       if this is set to true, the command "Salesforce Reference - All
     *       Documentation Types" will not include this documentation type.
     *       If set to false for a documentation type, uou'll only be able to
     *       view that documentation type with from the command specific to it,
     *       it won't be included in the command "Salesforce Reference - All
     *       Documentation Types"
     *
     *  Note to developers: the keys in `docTypes` should be an exact lowercase
     *   match of one of the keys in salesforce_reference.retrieve.DocTypeEnum
     */
    "docTypes": {
      "apex": {
        "refreshCacheOnLoad": true,
        "excludeFromAllDocumentationCommand": false
      },
      "visualforce": {
        "refreshCacheOnLoad": true,
        "excludeFromAllDocumentationCommand": false
      },
      "serviceconsole": {
        "refreshCacheOnLoad": false,
        "excludeFromAllDocumentationCommand": false
      }
    }
}

## Contributing, Bugs, Suggestions, Questions

If you have any suggestions or bugs to report, please open an issue and I'll take a look ASAP. If you have any questions or would like to contribute in any way, you can also get in touch with me by tweeting [@Oblongmana](http://twitter.com/oblongmana), or go ahead and fork the repo and submit a pull request.

Please note that we will roughly be following semver + git-flow for 2.0.0 onwards. The short version of that is - new branches should be made off the `develop` branch like so:
 - `fix/describe-your-fix` for bug fixes
 - `feature/describe-your-feature` for new features
 - `chore/describe-your-chore` for new things like minor documentation updates
Once complete, merge any remote changes to the `develop` branch into your local branch, and submit a pull request against the `develop` branch

When we're ready for a release, a release candidate will be branched off `develop` into `release-X.Y.Z` (`X.Y.Z` being the version number). This branch will be open to fixes only, no new features. Other maintenance things like release note changes, doc tweaks, will be accepted only if relevant to the release. Once complete, the release branch will be merged into master, tagged, and shipped.

If you don't follow those instructions precisely, it's probably no big deal, we'll try to make it work, but it may take longer or be more of a challenge.

### Adding new documentation sources

If there's a documentation source you want to add, please open an issue for discussion on why it should be included. Note that no documentation sources have been deliberately excluded yet - time to implement is the primary constraint!

Alternatively, if you want to have a go at adding it yourself, `salesforce_reference/retrieve.py` contains the necessary framework for doing so:
 - Create a new `DocRetrievalStrategy`, and add this to the `DocTypeEnum`, including modifying the `DocTypeEnum.get_all()` and `DocTypeEnum.get_by_name()` methods appropriately
 - Add settings for this to `SublimeSalesforceReference.sublime-settings`, under `docTypes`. Make sure the key you add to this is identical to the key you added in `DocTypeEnum`, but in lowercase
 - Add a new command in `SalesforceReference.py`, and create the command palette entry for it in `Default.sublime-commands`

## License

### Sublime Salesforce Reference
Copyright (c) 2014-2015 James Hill <[email protected]>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.


### ThreadProgress.py
ThreadProgress.py is licensed under the MIT license, and SalesforceReference.py's RetrieveIndexThread method derives in part from code under the same license

Copyright (c) 2011-2013 Will Bond <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


## Credits

All Salesforce Documentation is © Copyright 2000–2015 salesforce.com, inc.

Thanks to [Marco Zeuli](https://github.com/maaaaarco) for his contributions to making extra types of documentation available in the plugin

Credit to [Luke McFarlane](https://github.com/lukemcfarlane) for the inspiration!