netlinx-compile 3.1.1 → 3.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (67) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +91 -6
  3. data/doc/NetLinx.html +6 -6
  4. data/doc/NetLinx/Compile.html +6 -6
  5. data/doc/NetLinx/Compile/Extension.html +6 -6
  6. data/doc/NetLinx/Compile/Extension/AXS.html +6 -6
  7. data/doc/NetLinx/Compile/ExtensionDiscovery.html +21 -24
  8. data/doc/NetLinx/Compile/ExtensionHandler.html +20 -41
  9. data/doc/NetLinx/Compile/Script.html +6 -6
  10. data/doc/NetLinx/Compiler.html +9 -13
  11. data/doc/NetLinx/CompilerResult.html +7 -7
  12. data/doc/NetLinx/NoCompilerError.html +6 -6
  13. data/doc/NetLinx/Rake.html +6 -6
  14. data/doc/NetLinx/Rake/Compile.html +9 -10
  15. data/doc/NetLinx/SourceFile.html +39 -33
  16. data/doc/_index.html +7 -7
  17. data/doc/class_list.html +2 -2
  18. data/doc/css/style.css +6 -9
  19. data/doc/file.README.html +71 -29
  20. data/doc/file.license.html +6 -6
  21. data/doc/file_list.html +2 -2
  22. data/doc/frames.html +2 -2
  23. data/doc/index.html +71 -29
  24. data/doc/js/app.js +69 -3
  25. data/doc/method_list.html +22 -22
  26. data/doc/top-level-namespace.html +6 -6
  27. data/lib/netlinx/source_file.rb +4 -0
  28. metadata +9 -49
  29. data/doc/Test.html +0 -147
  30. data/doc/Test/NetLinx.html +0 -147
  31. data/doc/Test/NetLinx/Compilable.html +0 -148
  32. data/doc/Test/NetLinx/Compile.html +0 -146
  33. data/doc/Test/NetLinx/Compile/Discoverable.html +0 -148
  34. data/doc/Test/NetLinx/Compile/Invokable.html +0 -149
  35. data/doc/created.rid +0 -12
  36. data/doc/images/add.png +0 -0
  37. data/doc/images/arrow_up.png +0 -0
  38. data/doc/images/brick.png +0 -0
  39. data/doc/images/brick_link.png +0 -0
  40. data/doc/images/bug.png +0 -0
  41. data/doc/images/bullet_black.png +0 -0
  42. data/doc/images/bullet_toggle_minus.png +0 -0
  43. data/doc/images/bullet_toggle_plus.png +0 -0
  44. data/doc/images/date.png +0 -0
  45. data/doc/images/delete.png +0 -0
  46. data/doc/images/find.png +0 -0
  47. data/doc/images/loadingAnimation.gif +0 -0
  48. data/doc/images/macFFBgHack.png +0 -0
  49. data/doc/images/package.png +0 -0
  50. data/doc/images/page_green.png +0 -0
  51. data/doc/images/page_white_text.png +0 -0
  52. data/doc/images/page_white_width.png +0 -0
  53. data/doc/images/plugin.png +0 -0
  54. data/doc/images/ruby.png +0 -0
  55. data/doc/images/tag_blue.png +0 -0
  56. data/doc/images/tag_green.png +0 -0
  57. data/doc/images/transparent.png +0 -0
  58. data/doc/images/wrench.png +0 -0
  59. data/doc/images/wrench_orange.png +0 -0
  60. data/doc/images/zoom.png +0 -0
  61. data/doc/js/darkfish.js +0 -155
  62. data/doc/js/navigation.js +0 -142
  63. data/doc/js/search.js +0 -94
  64. data/doc/js/search_index.js +0 -1
  65. data/doc/js/searcher.js +0 -228
  66. data/doc/rdoc.css +0 -595
  67. data/doc/table_of_contents.html +0 -138
@@ -4,9 +4,9 @@
4
4
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
5
5
  <meta charset="utf-8" />
6
6
 
7
- <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
7
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
8
8
 
9
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
9
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
10
10
 
11
11
 
12
12
 
@@ -245,6 +245,7 @@ ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
245
245
 
246
246
  dl.constants { margin-left: 10px; }
247
247
  dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
248
+ dl.constants.compact dt { display: inline-block; font-weight: normal }
248
249
  dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-bottom: 18px; }
249
250
  dl.constants .docstring .note:first-child { margin-top: 5px; }
250
251
 
@@ -326,13 +327,9 @@ ul.summary a, ul.summary a:visited {
326
327
  text-decoration: none; font-size: 1.1em;
327
328
  }
328
329
  ul.summary li { margin-bottom: 5px; }
329
- .summary .summary_signature {
330
- padding: 4px 8px;
331
- background: #f8f8f8;
332
- border: 1px solid #f0f0f0;
333
- border-radius: 5px;
334
- }
330
+ .summary_signature { padding: 4px 8px; background: #f8f8f8; border: 1px solid #f0f0f0; border-radius: 5px; }
335
331
  .summary_signature:hover { background: #CFEBFF; border-color: #A4CCDA; cursor: pointer; }
332
+ .summary_signature.deprecated { background: #ffe5e5; border-color: #e9dada; }
336
333
  ul.summary.compact li { display: inline-block; margin: 0px 5px 0px 0px; line-height: 2.6em;}
337
334
  ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; }
338
335
  #content .summary_signature:hover a,
@@ -425,8 +422,8 @@ li.r2 { background: #fafafa; }
425
422
  #toc ol { padding-left: 1.8em; }
426
423
  #toc li { font-size: 1.1em; line-height: 1.7em; }
427
424
  #toc > ol > li { font-size: 1.1em; font-weight: bold; }
428
- #toc ol > ol { font-size: 0.9em; }
429
- #toc ol ol > ol { padding-left: 2.3em; }
425
+ #toc ol > li > ol { font-size: 0.9em; }
426
+ #toc ol ol > li > ol { padding-left: 2.3em; }
430
427
  #toc ol + li { margin-top: 0.3em; }
431
428
  #toc.hidden { padding: 10px; background: #fefefe; box-shadow: none; }
432
429
  #toc.hidden:hover { background: #fafafa; }
@@ -485,7 +482,7 @@ pre.code .rubyid_nth_ref { color: #6D79DE; }
485
482
  pre.code .regexp, .dregexp { color: #036A07; }
486
483
  pre.code a { border-bottom: 1px dotted #bbf; }
487
484
  /* inline code */
488
- p > code {
485
+ *:not(pre) > code {
489
486
  padding: 1px 3px 1px 3px;
490
487
  border: 1px solid #E1E1E8;
491
488
  background: #F7F7F9;
@@ -6,15 +6,15 @@
6
6
  <title>
7
7
  File: README
8
8
 
9
- &mdash; Documentation by YARD 0.9.12
9
+ &mdash; Documentation by YARD 0.9.25
10
10
 
11
11
  </title>
12
12
 
13
- <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
14
 
15
- <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
16
 
17
- <script type="text/javascript" charset="utf-8">
17
+ <script type="text/javascript">
18
18
  pathId = "README";
19
19
  relpath = '';
20
20
  </script>
@@ -64,27 +64,13 @@
64
64
 
65
65
  <p>A wrapper utility for the AMX NetLinx compiler.</p>
66
66
 
67
- <p><a href="http://badge.fury.io/rb/netlinx-compile"><img
68
- src="https://badge.fury.io/rb/netlinx-compile.png"></a></p>
67
+ <p><a href="http://badge.fury.io/rb/netlinx-compile"><img src="https://badge.fury.io/rb/netlinx-compile.png"></a> <a href="http://www.rubydoc.info/gems/netlinx-compile"><img src="https://img.shields.io/badge/docs-api-blue.svg"></a> <a href="http://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/license-Apache%202.0-yellowgreen.svg"></a></p>
69
68
 
70
- <p>This library provides an executable, <code>netlinx-compile</code>, that
71
- wraps the <code>nlrc.exe</code> NetLinx compiler provided by AMX. It is
72
- designed for easier command line access, as well as for integration with
73
- third-party tools with source code build support, like text editors and
74
- IDE&#39;s. Also provided in this library is a Ruby API for invoking the
75
- NetLinx compiler.</p>
69
+ <p>This library provides an executable, <code>netlinx-compile</code>, that wraps the <code>nlrc.exe</code> NetLinx compiler provided by AMX. It is designed for easier command line access, as well as for integration with third-party tools with source code build support, like text editors and IDE&#39;s. Also provided in this library is a Ruby API for invoking the NetLinx compiler.</p>
76
70
 
77
71
  <h2 id="label-Upgrade+Notice">Upgrade Notice</h2>
78
72
 
79
- <p>AMX has broken NetLinx compilier functionality between NLRC.exe v1.0
80
- (distributed with NetLinx Studio v3.x) and NLRC.exe v2.1 (distributed with
81
- NetLinx Studio 4). NLRC.exe v2.x was distributed with NetLinx Studio 4
82
- versions less than 4.1.1204, and has major problems. It is recommended to
83
- <em>avoid</em> NLRC.exe v2.x. NLRC.exe v3.x started being distributed in
84
- NetLinx Studio v4.1.1204 and appears to have fixed the problems when
85
- compiling include and Duet files. Due to the major changes in the NetLinx
86
- compiler, it may be necessary to use version 1.x of netlinx-compile when
87
- working with projects created with NetLinx Studio v3.x or earlier.</p>
73
+ <p>AMX has broken NetLinx compilier functionality between NLRC.exe v1.0 (distributed with NetLinx Studio v3.x) and NLRC.exe v2.1 (distributed with NetLinx Studio 4). NLRC.exe v2.x was distributed with NetLinx Studio 4 versions less than 4.1.1204, and has major problems. It is recommended to <em>avoid</em> NLRC.exe v2.x. NLRC.exe v3.x started being distributed in NetLinx Studio v4.1.1204 and appears to have <a href="https://github.com/amclain/netlinx-compile/issues/1">fixed the problems when compiling include and Duet files</a>. Due to the major changes in the NetLinx compiler, it may be necessary to use version 1.x of netlinx-compile when working with projects created with NetLinx Studio v3.x or earlier.</p>
88
74
  <ul><li>
89
75
  <p>Version 1.x of netlinx-compile targets NLRC.exe v1.x.</p>
90
76
  </li><li>
@@ -93,20 +79,76 @@ working with projects created with NetLinx Studio v3.x or earlier.

93
79
  <p>Version 3.x of netlinx-compile targets NLRC.exe v3.x.</p>
94
80
  </li></ul>
95
81
 
96
- <p><a
97
- href="https://github.com/amclain/netlinx-compile/labels/amx%20bug%20-%20can't%20fix">AMX
98
- NetLinx Compiler Bug List</a></p>
82
+ <p><a href="https://github.com/amclain/netlinx-compile/labels/amx%20bug%20-%20can't%20fix">AMX NetLinx Compiler Bug List</a></p>
99
83
 
100
- <h2 id="label-Documentation">Documentation</h2>
84
+ <h2 id="label-Installation">Installation</h2>
101
85
 
102
- <p><a
103
- href="https://sourceforge.net/p/netlinx-compile/wiki/Home/">sourceforge.net/p/netlinx-compile/wiki/Home/</a></p>
86
+ <p>netlinx-compile is available as a Ruby gem.</p>
87
+ <ol><li>
88
+ <p>Install <a href="http://www.ruby-lang.org/en/downloads/">Ruby</a> 2.0 or higher (For Windows use <a href="http://rubyinstaller.org/downloads/">RubyInstaller</a> and make sure ruby/bin is in your <a href="http://www.computerhope.com/issues/ch000549.htm">system path</a>.)</p>
89
+ </li><li>
90
+ <p>Open the <a href="http://www.addictivetips.com/windows-tips/windows-7-elevated-command-prompt-in-context-menu/">command line</a> and type:</p>
91
+ </li></ol>
92
+
93
+ <pre class="code ruby"><code class="ruby">gem install netlinx-compile
94
+ gem install netlinx-workspace (optional: for NetLinx Studio workspace support)
95
+ </code></pre>
96
+
97
+ <p><em>NOTE: The NetLinx compiler executable provided by AMX, nlrc.exe, must be installed on your computer for this utility to work. It is included in the NetLinx Studio installation by default.</em></p>
98
+
99
+ <p><strong>If you receive the following error when running gem install:</strong> <code>Unable to download data from https://rubygems.org/ - SSL_connect returned=1</code></p>
100
+
101
+ <p>Follow this guide: <a href="https://gist.github.com/luislavena/f064211759ee0f806c88">Workaround RubyGems’ SSL errors on Ruby for Windows (RubyInstaller)</a></p>
102
+
103
+ <h2 id="label-Issues-2C+Bugs-2C+Feature+Requests">Issues, Bugs, Feature Requests</h2>
104
+
105
+ <p>Any bugs and feature requests should be reported on the GitHub issue tracker:</p>
106
+
107
+ <p><a href="https://github.com/amclain/netlinx-compile/issues">github.com/amclain/netlinx-compile/issues</a></p>
108
+
109
+ <p><strong>Pull requests are preferred via GitHub.</strong></p>
110
+
111
+ <h2 id="label-Use">Use</h2>
112
+
113
+ <p><strong>Sublime Text Editor</strong></p>
114
+
115
+ <p>NetLinx Compile can be integrated into <a href="http://www.sublimetext.com/3">Sublime Text</a> with the <a href="https://github.com/amclain/sublime-netlinx">Sublime Text AMX NetLinx Plugin</a>. This allows NetLinx source code and workspaces to be compiled with the editor&#39;s built-in build commands.</p>
116
+
117
+ <p><strong>Command Line</strong></p>
118
+
119
+ <p>NetLinx Compile provides friendlier command line access than the traditional NetLinx compiler provided by AMX. For starters, files can now be entered by relative path (<code>my_file.axs</code>) as well as absolute path (<code>c:\path\to\my_file.axs</code>). A more advanced feature, workspace compiling, can invoke the NetLinx compiler on a workspace file, as well as intelligently seek out a workspace for a given source code file.</p>
120
+
121
+ <p>Compile a source code file.</p>
122
+
123
+ <pre class="code ruby"><code class="ruby">netlinx-compile -s my_source_code.axs
124
+ </code></pre>
125
+
126
+ <p>Compile a workspace (with <a href="https://github.com/amclain/netlinx-workspace">NetLinx Workspace</a> installed).</p>
127
+
128
+ <pre class="code ruby"><code class="ruby">netlinx-compile -s my_workspace.apw
129
+ </code></pre>
130
+
131
+ <p>Find the workspace that contains my_source_code.axs and compile it.</p>
132
+
133
+ <pre class="code ruby"><code class="ruby">netlinx-compile -w -s my_source_code.axs
134
+ </code></pre>
135
+
136
+ <p>Print all of the option flags and their descriptions.</p>
137
+
138
+ <pre class="code ruby"><code class="ruby">netlinx-compile -h
139
+ </code></pre>
140
+
141
+ <p><strong>Ruby Developer API</strong></p>
142
+
143
+ <p>A Ruby API is provided for developers looking to integrate the NetLinx Compile library into thier own tools. <a href="http://rubydoc.info/gems/netlinx-compile/frames">NetLinx Compile Developer Documentation</a></p>
144
+
145
+ <p>NetLinx Compile supports the ability to invoke the compiler on third-party files, like when creating new types of workspaces. To add NetLinx Compile support to your Ruby gem, create a handler for your file extension under the namespace NetLinx::Compile::Extension, place the .rb file under lib/netlinx/compile/extension in your gem, and add a dependency or development dependency in your gemspec to the netlinx-compile gem. NetLinx Compile will now automatically use your gem to compile the file extension it specifies. This is implemented in NetLinx::Compile::Extension::AXS, as well as in the <a href="https://github.com/amclain/netlinx-workspace">NetLinx Workspace</a> gem.</p>
104
146
  </div></div>
105
147
 
106
148
  <div id="footer">
107
- Generated on Tue Feb 13 21:36:33 2018 by
149
+ Generated on Sat Jul 11 17:29:50 2020 by
108
150
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
109
- 0.9.12 (ruby-2.1.8).
151
+ 0.9.25 (ruby-2.7.1).
110
152
  </div>
111
153
 
112
154
  </div>
@@ -6,15 +6,15 @@
6
6
  <title>
7
7
  File: license
8
8
 
9
- &mdash; Documentation by YARD 0.9.12
9
+ &mdash; Documentation by YARD 0.9.25
10
10
 
11
11
  </title>
12
12
 
13
- <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
14
 
15
- <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
16
 
17
- <script type="text/javascript" charset="utf-8">
17
+ <script type="text/javascript">
18
18
  pathId = "license";
19
19
  relpath = '';
20
20
  </script>
@@ -60,9 +60,9 @@
60
60
  <div id="content"><div id='filecontents'>Copyright 2013, 2015 Alex McLain<br/><br/>Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<br/>you may not use this file except in compliance with the License.<br/>You may obtain a copy of the License at<br/><br/> http://www.apache.org/licenses/LICENSE-2.0<br/><br/>Unless required by applicable law or agreed to in writing, software<br/>distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<br/>WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br/>See the License for the specific language governing permissions and<br/>limitations under the License.</div></div>
61
61
 
62
62
  <div id="footer">
63
- Generated on Tue Feb 13 21:36:33 2018 by
63
+ Generated on Sat Jul 11 17:29:50 2020 by
64
64
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
65
- 0.9.12 (ruby-2.1.8).
65
+ 0.9.25 (ruby-2.7.1).
66
66
  </div>
67
67
 
68
68
  </div>
@@ -4,9 +4,9 @@
4
4
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
5
5
  <meta charset="utf-8" />
6
6
 
7
- <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
7
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
8
8
 
9
- <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
9
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
10
10
 
11
11
 
12
12
 
@@ -2,9 +2,9 @@
2
2
  <html>
3
3
  <head>
4
4
  <meta charset="utf-8">
5
- <title>Documentation by YARD 0.9.12</title>
5
+ <title>Documentation by YARD 0.9.25</title>
6
6
  </head>
7
- <script type="text/javascript" charset="utf-8">
7
+ <script type="text/javascript">
8
8
  var match = unescape(window.location.hash).match(/^#!(.+)/);
9
9
  var name = match ? match[1] : 'index.html';
10
10
  name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
@@ -6,15 +6,15 @@
6
6
  <title>
7
7
  File: README
8
8
 
9
- &mdash; Documentation by YARD 0.9.12
9
+ &mdash; Documentation by YARD 0.9.25
10
10
 
11
11
  </title>
12
12
 
13
- <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
14
 
15
- <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
16
 
17
- <script type="text/javascript" charset="utf-8">
17
+ <script type="text/javascript">
18
18
  pathId = "README";
19
19
  relpath = '';
20
20
  </script>
@@ -64,27 +64,13 @@
64
64
 
65
65
  <p>A wrapper utility for the AMX NetLinx compiler.</p>
66
66
 
67
- <p><a href="http://badge.fury.io/rb/netlinx-compile"><img
68
- src="https://badge.fury.io/rb/netlinx-compile.png"></a></p>
67
+ <p><a href="http://badge.fury.io/rb/netlinx-compile"><img src="https://badge.fury.io/rb/netlinx-compile.png"></a> <a href="http://www.rubydoc.info/gems/netlinx-compile"><img src="https://img.shields.io/badge/docs-api-blue.svg"></a> <a href="http://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/license-Apache%202.0-yellowgreen.svg"></a></p>
69
68
 
70
- <p>This library provides an executable, <code>netlinx-compile</code>, that
71
- wraps the <code>nlrc.exe</code> NetLinx compiler provided by AMX. It is
72
- designed for easier command line access, as well as for integration with
73
- third-party tools with source code build support, like text editors and
74
- IDE&#39;s. Also provided in this library is a Ruby API for invoking the
75
- NetLinx compiler.</p>
69
+ <p>This library provides an executable, <code>netlinx-compile</code>, that wraps the <code>nlrc.exe</code> NetLinx compiler provided by AMX. It is designed for easier command line access, as well as for integration with third-party tools with source code build support, like text editors and IDE&#39;s. Also provided in this library is a Ruby API for invoking the NetLinx compiler.</p>
76
70
 
77
71
  <h2 id="label-Upgrade+Notice">Upgrade Notice</h2>
78
72
 
79
- <p>AMX has broken NetLinx compilier functionality between NLRC.exe v1.0
80
- (distributed with NetLinx Studio v3.x) and NLRC.exe v2.1 (distributed with
81
- NetLinx Studio 4). NLRC.exe v2.x was distributed with NetLinx Studio 4
82
- versions less than 4.1.1204, and has major problems. It is recommended to
83
- <em>avoid</em> NLRC.exe v2.x. NLRC.exe v3.x started being distributed in
84
- NetLinx Studio v4.1.1204 and appears to have fixed the problems when
85
- compiling include and Duet files. Due to the major changes in the NetLinx
86
- compiler, it may be necessary to use version 1.x of netlinx-compile when
87
- working with projects created with NetLinx Studio v3.x or earlier.</p>
73
+ <p>AMX has broken NetLinx compilier functionality between NLRC.exe v1.0 (distributed with NetLinx Studio v3.x) and NLRC.exe v2.1 (distributed with NetLinx Studio 4). NLRC.exe v2.x was distributed with NetLinx Studio 4 versions less than 4.1.1204, and has major problems. It is recommended to <em>avoid</em> NLRC.exe v2.x. NLRC.exe v3.x started being distributed in NetLinx Studio v4.1.1204 and appears to have <a href="https://github.com/amclain/netlinx-compile/issues/1">fixed the problems when compiling include and Duet files</a>. Due to the major changes in the NetLinx compiler, it may be necessary to use version 1.x of netlinx-compile when working with projects created with NetLinx Studio v3.x or earlier.</p>
88
74
  <ul><li>
89
75
  <p>Version 1.x of netlinx-compile targets NLRC.exe v1.x.</p>
90
76
  </li><li>
@@ -93,20 +79,76 @@ working with projects created with NetLinx Studio v3.x or earlier.

93
79
  <p>Version 3.x of netlinx-compile targets NLRC.exe v3.x.</p>
94
80
  </li></ul>
95
81
 
96
- <p><a
97
- href="https://github.com/amclain/netlinx-compile/labels/amx%20bug%20-%20can't%20fix">AMX
98
- NetLinx Compiler Bug List</a></p>
82
+ <p><a href="https://github.com/amclain/netlinx-compile/labels/amx%20bug%20-%20can't%20fix">AMX NetLinx Compiler Bug List</a></p>
99
83
 
100
- <h2 id="label-Documentation">Documentation</h2>
84
+ <h2 id="label-Installation">Installation</h2>
101
85
 
102
- <p><a
103
- href="https://sourceforge.net/p/netlinx-compile/wiki/Home/">sourceforge.net/p/netlinx-compile/wiki/Home/</a></p>
86
+ <p>netlinx-compile is available as a Ruby gem.</p>
87
+ <ol><li>
88
+ <p>Install <a href="http://www.ruby-lang.org/en/downloads/">Ruby</a> 2.0 or higher (For Windows use <a href="http://rubyinstaller.org/downloads/">RubyInstaller</a> and make sure ruby/bin is in your <a href="http://www.computerhope.com/issues/ch000549.htm">system path</a>.)</p>
89
+ </li><li>
90
+ <p>Open the <a href="http://www.addictivetips.com/windows-tips/windows-7-elevated-command-prompt-in-context-menu/">command line</a> and type:</p>
91
+ </li></ol>
92
+
93
+ <pre class="code ruby"><code class="ruby">gem install netlinx-compile
94
+ gem install netlinx-workspace (optional: for NetLinx Studio workspace support)
95
+ </code></pre>
96
+
97
+ <p><em>NOTE: The NetLinx compiler executable provided by AMX, nlrc.exe, must be installed on your computer for this utility to work. It is included in the NetLinx Studio installation by default.</em></p>
98
+
99
+ <p><strong>If you receive the following error when running gem install:</strong> <code>Unable to download data from https://rubygems.org/ - SSL_connect returned=1</code></p>
100
+
101
+ <p>Follow this guide: <a href="https://gist.github.com/luislavena/f064211759ee0f806c88">Workaround RubyGems’ SSL errors on Ruby for Windows (RubyInstaller)</a></p>
102
+
103
+ <h2 id="label-Issues-2C+Bugs-2C+Feature+Requests">Issues, Bugs, Feature Requests</h2>
104
+
105
+ <p>Any bugs and feature requests should be reported on the GitHub issue tracker:</p>
106
+
107
+ <p><a href="https://github.com/amclain/netlinx-compile/issues">github.com/amclain/netlinx-compile/issues</a></p>
108
+
109
+ <p><strong>Pull requests are preferred via GitHub.</strong></p>
110
+
111
+ <h2 id="label-Use">Use</h2>
112
+
113
+ <p><strong>Sublime Text Editor</strong></p>
114
+
115
+ <p>NetLinx Compile can be integrated into <a href="http://www.sublimetext.com/3">Sublime Text</a> with the <a href="https://github.com/amclain/sublime-netlinx">Sublime Text AMX NetLinx Plugin</a>. This allows NetLinx source code and workspaces to be compiled with the editor&#39;s built-in build commands.</p>
116
+
117
+ <p><strong>Command Line</strong></p>
118
+
119
+ <p>NetLinx Compile provides friendlier command line access than the traditional NetLinx compiler provided by AMX. For starters, files can now be entered by relative path (<code>my_file.axs</code>) as well as absolute path (<code>c:\path\to\my_file.axs</code>). A more advanced feature, workspace compiling, can invoke the NetLinx compiler on a workspace file, as well as intelligently seek out a workspace for a given source code file.</p>
120
+
121
+ <p>Compile a source code file.</p>
122
+
123
+ <pre class="code ruby"><code class="ruby">netlinx-compile -s my_source_code.axs
124
+ </code></pre>
125
+
126
+ <p>Compile a workspace (with <a href="https://github.com/amclain/netlinx-workspace">NetLinx Workspace</a> installed).</p>
127
+
128
+ <pre class="code ruby"><code class="ruby">netlinx-compile -s my_workspace.apw
129
+ </code></pre>
130
+
131
+ <p>Find the workspace that contains my_source_code.axs and compile it.</p>
132
+
133
+ <pre class="code ruby"><code class="ruby">netlinx-compile -w -s my_source_code.axs
134
+ </code></pre>
135
+
136
+ <p>Print all of the option flags and their descriptions.</p>
137
+
138
+ <pre class="code ruby"><code class="ruby">netlinx-compile -h
139
+ </code></pre>
140
+
141
+ <p><strong>Ruby Developer API</strong></p>
142
+
143
+ <p>A Ruby API is provided for developers looking to integrate the NetLinx Compile library into thier own tools. <a href="http://rubydoc.info/gems/netlinx-compile/frames">NetLinx Compile Developer Documentation</a></p>
144
+
145
+ <p>NetLinx Compile supports the ability to invoke the compiler on third-party files, like when creating new types of workspaces. To add NetLinx Compile support to your Ruby gem, create a handler for your file extension under the namespace NetLinx::Compile::Extension, place the .rb file under lib/netlinx/compile/extension in your gem, and add a dependency or development dependency in your gemspec to the netlinx-compile gem. NetLinx Compile will now automatically use your gem to compile the file extension it specifies. This is implemented in NetLinx::Compile::Extension::AXS, as well as in the <a href="https://github.com/amclain/netlinx-workspace">NetLinx Workspace</a> gem.</p>
104
146
  </div></div>
105
147
 
106
148
  <div id="footer">
107
- Generated on Tue Feb 13 21:36:33 2018 by
149
+ Generated on Sat Jul 11 17:29:50 2020 by
108
150
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
109
- 0.9.12 (ruby-2.1.8).
151
+ 0.9.25 (ruby-2.7.1).
110
152
  </div>
111
153
 
112
154
  </div>
@@ -120,6 +120,49 @@ function summaryToggle() {
120
120
  } else { localStorage.summaryCollapsed = "expand"; }
121
121
  }
122
122
 
123
+ function constantSummaryToggle() {
124
+ $('.constants_summary_toggle').click(function(e) {
125
+ e.preventDefault();
126
+ localStorage.summaryCollapsed = $(this).text();
127
+ $('.constants_summary_toggle').each(function() {
128
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
129
+ var next = $(this).parent().parent().nextAll('dl.constants').first();
130
+ if (next.hasClass('compact')) {
131
+ next.toggle();
132
+ next.nextAll('dl.constants').first().toggle();
133
+ }
134
+ else if (next.hasClass('constants')) {
135
+ var list = $('<dl class="constants compact" />');
136
+ list.html(next.html());
137
+ list.find('dt').each(function() {
138
+ $(this).addClass('summary_signature');
139
+ $(this).text( $(this).text().split('=')[0]);
140
+ if ($(this).has(".deprecated").length) {
141
+ $(this).addClass('deprecated');
142
+ };
143
+ });
144
+ // Add the value of the constant as "Tooltip" to the summary object
145
+ list.find('pre.code').each(function() {
146
+ console.log($(this).parent());
147
+ var dt_element = $(this).parent().prev();
148
+ var tooltip = $(this).text();
149
+ if (dt_element.hasClass("deprecated")) {
150
+ tooltip = 'Deprecated. ' + tooltip;
151
+ };
152
+ dt_element.attr('title', tooltip);
153
+ });
154
+ list.find('.docstring, .tags, dd').remove();
155
+ next.before(list);
156
+ next.toggle();
157
+ }
158
+ });
159
+ return false;
160
+ });
161
+ if (localStorage.summaryCollapsed == "collapse") {
162
+ $('.constants_summary_toggle').first().click();
163
+ } else { localStorage.summaryCollapsed = "expand"; }
164
+ }
165
+
123
166
  function generateTOC() {
124
167
  if ($('#filecontents').length === 0) return;
125
168
  var _toc = $('<ol class="top"></ol>');
@@ -128,6 +171,7 @@ function generateTOC() {
128
171
  var counter = 0;
129
172
  var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
130
173
  var i;
174
+ var curli;
131
175
  if ($('#filecontents h1').length > 1) tags.unshift('h1');
132
176
  for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
133
177
  var lastTag = parseInt(tags[0][1], 10);
@@ -147,15 +191,25 @@ function generateTOC() {
147
191
  }
148
192
  if (thisTag > lastTag) {
149
193
  for (i = 0; i < thisTag - lastTag; i++) {
150
- var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
194
+ if ( typeof(curli) == "undefined" ) {
195
+ curli = $('<li/>');
196
+ toc.append(curli);
197
+ }
198
+ toc = $('<ol/>');
199
+ curli.append(toc);
200
+ curli = undefined;
151
201
  }
152
202
  }
153
203
  if (thisTag < lastTag) {
154
- for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
204
+ for (i = 0; i < lastTag - thisTag; i++) {
205
+ toc = toc.parent();
206
+ toc = toc.parent();
207
+ }
155
208
  }
156
209
  var title = $(this).attr('toc-title');
157
210
  if (typeof(title) == "undefined") title = $(this).text();
158
- toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
211
+ curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>');
212
+ toc.append(curli);
159
213
  lastTag = thisTag;
160
214
  });
161
215
  if (!show) return;
@@ -232,6 +286,16 @@ function mainFocus() {
232
286
  setTimeout(function() { $('#main').focus(); }, 10);
233
287
  }
234
288
 
289
+ function navigationChange() {
290
+ // This works around the broken anchor navigation with the YARD template.
291
+ window.onpopstate = function() {
292
+ var hash = window.location.hash;
293
+ if (hash !== '' && $(hash)[0]) {
294
+ $(hash)[0].scrollIntoView();
295
+ }
296
+ };
297
+ }
298
+
235
299
  $(document).ready(function() {
236
300
  navResizer();
237
301
  navExpander();
@@ -241,8 +305,10 @@ $(document).ready(function() {
241
305
  searchFrameButtons();
242
306
  linkSummaries();
243
307
  summaryToggle();
308
+ constantSummaryToggle();
244
309
  generateTOC();
245
310
  mainFocus();
311
+ navigationChange();
246
312
  });
247
313
 
248
314
  })();