-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathdeveloper-guide.html
More file actions
250 lines (233 loc) · 9.55 KB
/
Copy pathdeveloper-guide.html
File metadata and controls
250 lines (233 loc) · 9.55 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<title>Scribble - How to develop with Scribble</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="">
<meta name="keywords" content="">
<meta name="generator" content="JBake">
<!-- css -->
<link href="//maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css" rel="stylesheet">
<link href="../../css/bootstrap.min.css" rel="stylesheet">
<link href="../../css/asciidoctor.css" rel="stylesheet">
<link href="../../css/base.css" rel="stylesheet">
<link href="../../css/styles.css" rel="stylesheet">
<link href="../../css/prettify.css" rel="stylesheet">
<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="../../js/html5shiv.min.js"></script>
<![endif]-->
<!-- Fav and touch icons -->
<!--<link rel="apple-touch-icon-precomposed" sizes="144x144" href="../assets/ico/apple-touch-icon-144-precomposed.png">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="../assets/ico/apple-touch-icon-114-precomposed.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="../assets/ico/apple-touch-icon-72-precomposed.png">
<link rel="apple-touch-icon-precomposed" href="../assets/ico/apple-touch-icon-57-precomposed.png">-->
<link rel="shortcut icon" href="../../favicon.ico">
</head>
<body onload="prettyPrint()" data-spy="scroll" data-offset="80" data-target="#toc">
<div id="wrap">
<div class="dropup">
<script>
window.addEventListener('load', function() {
renderTabzilla("Scribble", "https://scribble.github.io", true );
}, false);
</script>
</div>
<!-- Fixed navbar -->
<nav class="navbar navbar-fixed-top" role="navigation">
<div class="container">
<!-- Brand and toggle get grouped for better mobile display -->
<!--
-->
<div class="navbar-header">
<button class="navbar-toggle collapsed" data-target="#bs-example-navbar-collapse-1" data-toggle="collapse" type="button">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav">
<li><a href="../../index.html">Home</a></li>
<li>
<a href="../../docs/overview/getting-started.html">Getting
Started</a>
</li>
<li class="dropdown">
<a aria-expanded="false" class="dropdown-toggle" data-toggle="dropdown" href="#" role="button">
Documentation<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<!--<li>
<a href="../../docs/user/user-guide.html">User Documentation</a>
</li>-->
<li>
<a href="../../docs/scribble-java.html#QUICK">Quick Start (Scribble-Java)</a>
</li>
<li>
<a href="../../docs/scribble-java.html#SCRIBCORE">Language Reference</a>
</li>
<li class="menu-item dropdown dropdown-submenu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Java Tooling</a>
<ul class="dropdown-menu">
<li class="menu-item ">
<a href="../../docs/scribble-java.html">API Generation Tutorial</a>
</li>
</ul>
</li>
<li class="menu-item dropdown dropdown-submenu">
<a href="#" class="dropdown-toggle" data-toggle="dropdown">Scala Tooling</a>
<ul class="dropdown-menu">
<li class="menu-item ">
<a href="../../docs/scribble-scala.html">API Generation Tutorial and Demo Artifact</a>
</li>
</ul>
</li>
</ul>
</li>
<li class=""><a href="../../downloads.html">Downloads</a></li>
<li class="dropdown"><a aria-expanded="false" class="dropdown-toggle" data-toggle="dropdown" href="#" role="button">
Community
<span class="caret"></span>
</a>
<ul class="dropdown-menu" role="menu">
<li>
<a href="https://groups.google.com/forum/#!forum/scribble-user">User Forum</a>
</li>
<li>
<a href="https://groups.google.com/forum/#!forum/scribble-lang">Scribble Language Forum</a>
</li>
<li>
<a href="../../community/issues.html">Reporting Issues</a>
</li>
<li>
<a href="../../blog.html">Blog</a>
</li>
<li>
<a href="../../community/collaborators.html">Collaborators</a>
</li>
<li>
<a href="../../license.html">License</a>
</li>
<li>
<a href="https://travis-ci.org/scribble">CI Builds</a>
</li>
</ul></li>
</ul>
</div>
</div>
</nav>
<section class="main-banner">
<div class="container">
<h1>How to develop with Scribble</h1>
<p>Developing with Scribble</p>
</div>
</section>
<!--<p><em>21 April 2015</em></p>-->
<section>
<div class="container">
<div id="preamble">
<div class="sectionbody">
<div id="toc" class="toc">
<div id="toctitle" class="title"></div>
<ul class="sectlevel1">
<li><a href="#_developing_scribble">Developing Scribble</a>
<ul class="sectlevel2">
<li><a href="#_project_code">Project Code</a></li>
<li><a href="#_contributing_to_the_project">Contributing to the Project</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_developing_scribble">Developing Scribble</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_project_code">Project Code</h3>
<div class="paragraph">
<p>The source code for the Scribble project is located on github in the <a href="http://www.github.com/scribble">Scribble organisation</a>.</p>
</div>
<div class="paragraph">
<p>The organisation is divided into a number of git repositories. The main repositories currently are:</p>
</div>
<div class="sect3">
<h4 id="_scribble_java">Scribble Java</h4>
<div class="paragraph">
<p>The repository is located <a href="http://www.github.com/scribble/scribble-java">here</a>.</p>
</div>
<div class="paragraph">
<p>This repository contains the core java code for the Scribble parser, validation, projection and monitoring capabilities.</p>
</div>
</div>
<div class="sect3">
<h4 id="_scribble_web">Scribble Web</h4>
<div class="paragraph">
<p>The repository is located <a href="http://www.github.com/scribble/scribble-web">here</a>.</p>
</div>
<div class="paragraph">
<p>This repository provides the web tooling. The server side capabilities are implemented in java, with the UI implemented using AngularJS/Bootstrap.</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_contributing_to_the_project">Contributing to the Project</h3>
<div class="paragraph">
<p>The best way to initially contribute to the project is to try out the tools and provide feedback by creating issues for feature requests or problems found.</p>
</div>
<div class="paragraph">
<p>The next step could be to provide contributions for the issues listed against any of the git repositories. These can be contributed as <em>pull requests</em>, which can then be reviewed by the project developers.</p>
</div>
<div class="admonitionblock warning">
<table>
<tr>
<td class="icon">
<i class="fa icon-warning" title="Warning"></i>
</td>
<td class="content">
Documentation for the older version of the tools can be found <a href="http://docs.jboss.org/scribble/latest/developerguide/html">here</a>.
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
</section>
</div>
</div>
<section>
<div class="container">
<p class="muted credit">© Scribble.org, 2009-2015 | Baked with <a href="http://jbake.org">JBake v2.3.2</a></p>
<p id="forkongithubp"><span id="forkongithub">
<a href="https://github.com/scribble" class="bg-grey">
Fork me on GitHub
</a>
</span></p>
</div>
</section>
<!-- javascript -->
<!-- Placed at the end of the document so the pages load faster -->
<!-- js -->
<script src="../../js/jquery-1.11.2.min.js"></script>
<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
<script src="../../js/behavior.js"></script>
<script src="../../js/prettify.js"></script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-xxxyyyxy-z']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>