View source for Atom

== Description ==

An all around NSIS language package for GitHub's new [http://atom.io/ Atom] editor

=== Grammar ===

Syntax highlighting of all commands in NSIS versions 2.46 & 3.0b1 and their included plug-ins

=== Completions ===

Tab-completions for syntax, useful snippets for quick scaffolding

https://raw.githubusercontent.com/idleberg/atom-language-nsis/master/screenshot.gif

=== Extension Packages ===

You can further extend [http://atom.io/packages/search?utf8=%E2%9C%93&q=keyword:nsis #nsis] support in Atom.

* [http://atom.io/packages/nsis-plugins 3rd party plug-ins]
* [http://atom.io/packages/language-nlf NSIS Language File]
* [http://atom.io/packages/language-nsl nsL Assembler]

== Installation ==

=== Atom Package Manager (apm) ===

Install package from <code>apm install language-nsis</code> (or use the GUI)

=== Git  ===

Change to the Atom package directory and clone the repository:

<code>git clone <nowiki>https://github.com/idleberg/atom-language-nsis.git language-nsis</nowiki></code>

== Usage ==

=== Completion ===

With most commands, you can specify available options before completion. For instance, rather than completing <code>RequestExecutionLevel</code> and then specifying an option, you can directly choose <code>RequestExecutionLevel user</code> from the completion menu.

To complete compile time commands, variables or predefines, *leave out* special characters:

* <code>include</code> completes to <code>!include</code>
* <code>INSTDIR</code> completes to <code>$INSTDIR</code>
* <code>NSIS_VERSION</code> completes to <code>${NSIS_VERSION}`</code>

However, you have to type <code>__LINE___</code> to complete to <code>${__LINE__}</code>.

There are several special cases for your convenience:

* <code>MB_OK</code> completes to <code>MessageBox MB_OK</code>
* <code>onInit</code> completes to a <code>Function .onInit</code> block
* <code>LogicLib</code> completes to <code>!include "LogicLib.nsh"`</code>

=== Building ===

This package comes with support for [http://atom.io/packages/atom-runner atom-runner] to let you compile scripts within Atom. Once atom-runner is installed, you can use the default shortcut <kbd>Ctrl</kbd>+<kbd>R</kbd> to compile open scripts. Make sure to save new scripts before trying to compile them.

== Links ==
* [https://github.com/idleberg/language-nsis GitHub]<br />

[[Category:Syntax_Highlighting]]
[[Category:Development Environments]]