Sublime 
===============
Znuny (Znuny-Sublime) is a Sublime Text 2/3 plugin that helps you to make Znuny development less painful.
### Feature List
* Add folder from workspace to project.
* Automatic fetching of framework files from github.
* Automatic generate SOPM file list.
* Automatic creation of the ObjectDependencies array.
* Automatic quoting with custom markers via keyboard shortcut.
* Znuny code snippets for fast, consistent and error free coding.
### Installation
To install this plugin, you have three options:
1. If you have [Sublime Package Control](http://wbond.net/sublime_packages/package_control) installed, simply search for `Znuny` to install.
2. Clone source code to Sublime Text packages folder *Sublime Text 2/Packages* or *Sublime Text 3/Packages*.
3. Download archive with the latest [release](https://github.com/znuny/Znuny-Sublime/releases) and unpack it to Sublime Text packages folder *Sublime Text 2/Packages* or *Sublime Text 3/Packages*.
*OSX*
cd ~/Library/Application\ Support/Sublime\ Text\ 2/Packages/
- or ST 3 -
cd ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/
git clone git://github.com/znuny/Znuny-Sublime.git Znuny
*Linux*
cd ~/.config/sublime-text-2/Packages
- or ST 3 -
cd ~/.config/sublime-text-3/Packages
git clone git://github.com/znuny/Znuny-Sublime.git Znuny
*Windows*
cd "%APPDATA%\Sublime Text 2\Packages"
- or ST 3 -
cd "%APPDATA%\Sublime Text 3\Packages"
git clone git://github.com/znuny/Znuny-Sublime.git Znuny
### Usage
#### znuny code templates
```znuny``` + Sublime Text autocomplete (command ```auto_complete```)
#### Add folder from workspace(s) to project
**Shortcut:** ```strg + alt + z, p```
**Command:** ```Znuny: Add Folder to Project```
Provides a searchable list of folders that can be added to the project. All folders of configurable workspace folders will be displayed.
Preferences -> Package Settings -> Znuny -> Settings -> "znuny_workspaces"
#### Fetching Znuny files from github
**Shortcut:** ```strg + alt + z, c```
**Command:** ```Znuny: Customizer```
Opens a project, branch and file selection list to chose a framework or addon file from. The file will get fetched live from the selected github branch and added to the (selected) folder. The Znuny copyright and the origin tag will be added automatically to the file header for you. The file will also be automatically added to the 'Custom/' directory in case it's a file with one of the file extensions '.pm', '.dtl' or '.tt'.
The GitHub API is limited to 60 requests per hour for non authorized requests. You can provide your GitHub username and an access token to push this limit to 5000 requests per hour. Please see the [official github doc](https://docs.github.com/en/free-pro-team@latest/rest/rate-limit/rate-limit?apiVersion=2022-11-28) for further information.
You can generate the access token in your [github settings](https://github.com/settings/tokens).
To add your access credentials go to:
Preferences -> Package Settings -> Znuny -> Settings
And add the settings "znuny_github_username" and "znuny_github_token" accordingly.
#### Creating SOPM Filelist from project
**Shortcut:** ```strg + alt + z, f```
**Command:** ```Znuny: Generate SOPM FileList```
Inserts the SOPM Filelist content containing all files of a selectable project.
#### Automatic creation of the ObjectDependencies array
**Shortcut:** ```strg + alt + z, d```
**Command:** ```Znuny: Generate ObjectDependencies```
Inserts the @ObjectDependencies array by parsing the file content. Only regular used OM calls are supported.
#### Automatic custom marker quoting
**Shortcut:** ```strg + alt + z, q```
**Command:** ```Znuny: Quote with Marker```
Works with active Perl, JavaScript and HTML syntax.
### Commercial Support
For this extension and for Znuny in general visit [http://znuny.com](http://znuny.com). Looking forward to hear from you!
Enjoy!
Your Znuny Team!
[http://znuny.com](http://znuny.com)