-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.html
707 lines (648 loc) · 17.8 KB
/
README.html
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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.3" />
<title>Linguist 0.4 README</title>
<style type="text/css">
/* Sans-serif font. */
h1, h2, h3, h4, h5, h6,
div.title, caption.title,
thead, p.table.header,
div#toctitle,
span#author, span#revnumber, span#revdate, span#revremark,
div#footer {
font-family: Arial,Helvetica,sans-serif;
}
/* Serif font. */
div.sectionbody {
font-family: Georgia,"Times New Roman",Times,serif;
}
/* Monospace font. */
tt {
font-size: inherit;
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
tt {
font-size: inherit;
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
div.sectionbody {
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
ul > li { color: #aaa; }
ul > li > * { color: black; }
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revnumber, span#revdate, span#revremark {
}
div#footer {
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid #dddddd;
border-left: 4px solid #f0f0f0;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid #dddddd;
border-left: 5px solid #f0f0f0;
background: #f8f8f8;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #f0f0f0;
color: #777777;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
font-size: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-weight: bold;
color: #527bbd;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
div.colist td {
padding-right: 0.5em;
padding-bottom: 0.3em;
vertical-align: top;
}
div.colist td img {
margin-top: 0.3em;
}
@media print {
div#footer-badges { display: none; }
}
div#toc {
margin-bottom: 2.5em;
}
div#toctitle {
color: #527bbd;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
</style>
<script type="text/javascript">
/*<+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
var cont = document.getElementById("content");
var noteholder = document.getElementById("footnotes");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
}
}
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1>Linguist 0.4 README</h1>
</div>
<div id="content">
<div class="sect1">
<h2 id="_0_description">0 Description</h2>
<div class="sectionbody">
<div class="paragraph"><p>Linguist is an extension for Visual Studio 2010 allowing customizable syntax highlighting
based on file names. Support for new languages may be easily added using regular expressions
to identify the various language elements and language elements may be customized using
different fonts, point sizes, colors, and font styles (e.g. bold and italic). The built-in
languages include C#, C++, C, Python, Makefiles, patch files, etc.</p></div>
<div class="paragraph"><p>To install the extension close studio and double-click the <tt>Linguist.vsix</tt> file. To uninstall the extension
select the Extension Manager… item from Studio’s Tool menu, select Linguist, and press the
Uninstall button. To upgrade the extension uninstall the old version and install the new version.</p></div>
<div class="paragraph"><p>To check for newer versions of the extension visit <a href="https://github.com/jesse99/Linguist">github</a>. The
software is distributed under the terms of the MIT.X11 licensing agreement (see Licence.txt).</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_1_operation">1 Operation</h2>
<div class="sectionbody">
<div class="paragraph"><p>When the extension starts up for the first time it will create standard and custom directories
inside <tt>%LOCALAPPDATA%\Linguist</tt> or <tt>%USERPROFILE%\AppData\Local\Linguist</tt> (typically this will
be something like <tt>C:\Users\<user name>\AppData\Local\Linguist</tt>). The standard directory will contain the built-in
language and style files. The custom directory will be empty. When the extension starts up again
old or missing files in the standard directory will be added or updated.</p></div>
<div class="paragraph"><p>Files within the custom directory can be used to define new languages or to override
files within the standard directory. Errors are written to a <tt>Log.txt</tt> file in the AppData directory.</p></div>
<div class="paragraph"><p>Language and style files are written using a simple line-oriented file format. Lines that start
with a <tt>#</tt> are comments. Lines with only white space are ignored. Fields start with an identifier,
followed by a colon, followed by arbitrary text. Identifiers start with a letter followed by alpha-numeric
characters, underscrores, and dashes.</p></div>
<div class="paragraph"><p>Testing source code changes with the solution is quite simple: make your change, press F5, and a special instance
of Studio will launch with the new version of the extension active. Breakpoints may be used
normally.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_2_style_file">2 Style File</h2>
<div class="sectionbody">
<div class="paragraph"><p>The Styles.field file is used to define how to render the various language elements. For example
the default style for Makefile targets is:</p></div>
<div class="ulist"><ul>
<li>
<p>
<strong>Name:</strong> target
</p>
</li>
<li>
<p>
<strong>ForeColor:</strong> DarkGreen
</p>
</li>
<li>
<p>
<strong>PointSize:</strong> 14
</p>
</li>
<li>
<p>
<strong>Bold:</strong> true
</p>
</li>
</ul></div>
<div class="paragraph"><p>The following fields can be used within a style file:</p></div>
<div class="ulist"><ul>
<li>
<p>
<strong>Name:</strong> the name of the language element (this is the only required field).
</p>
</li>
<li>
<p>
<strong>FontName:</strong> the name of a font, e.g. Consolas or Verdana.
</p>
</li>
<li>
<p>
<strong>PointSize:</strong> the font size, e.g. 12.
</p>
</li>
<li>
<p>
<strong>ForeColor:</strong> an <a href="http://en.wikipedia.org/wiki/Web_colors#X11_color_names">X11 color</a> name (Red), a hex color (#FF0000), or a decimal color 255,0,0.
</p>
</li>
<li>
<p>
<strong>BackColor:</strong> an <a href="http://en.wikipedia.org/wiki/Web_colors#X11_color_names">X11 color</a> name (White), a hex color (#FFFFFF), or a decimal color 255,255,255.
</p>
</li>
<li>
<p>
<strong>Bold:</strong> true if the element should be in bold, and false otherwise.
</p>
</li>
<li>
<p>
<strong>Italic:</strong> true if the element should be italicized, and false otherwise.
</p>
</li>
</ul></div>
<div class="paragraph"><p>The default element is special and applies to all text within a document. Other elements override
any styles used by the default element. Changes to Styles.field files require a restart of Studio
to take effect.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_3_language_files">3 Language Files</h2>
<div class="sectionbody">
<div class="paragraph"><p>Language files are used to define the language elements used by the language. The language
elements are matched using globs and the elements are matched using .NET <a href="http://msdn.microsoft.com/en-us/library/hs600312.aspx">regular expressions</a>.
The regexen are
compiled using RegexOptions.IgnorePatternWhitespace | RegexOptions.Multiline (so dot does not match new line characters).
If parenthesis are used within a regular expression they must be non-grouping (i.e. (?: pattern)).</p></div>
<div class="paragraph"><p>Here is an example:</p></div>
<div class="ulist"><ul>
<li>
<p>
<strong>Language:</strong> ini
</p>
</li>
<li>
<p>
<strong>Globs:</strong> *.ini
</p>
</li>
<li>
<p>
<strong>Comment:</strong> \x23 .* $
</p>
</li>
<li>
<p>
<strong>Preprocess:</strong> ^ \[ [a-zA-Z] [a-zA-Z0-9_ ]* \]
</p>
</li>
</ul></div>
<div class="paragraph"><p>The following fields can be used within a language file:</p></div>
<div class="ulist"><ul>
<li>
<p>
<strong>Language:</strong> the name of the language, e.g. makefile.
</p>
</li>
<li>
<p>
<strong>Globs:</strong> space separated list of file name globs where the meta-characters are * and ?, e.g.
Makefile *.mk.
</p>
</li>
<li>
<p>
<strong>Element:</strong> the name of a language element followed by the associated regular expression.
The name may be Attribute, Command, Comment, Default, DiffLoc, Emphasis, Header1, Header2, Header3, Header4, Header5, Italic, Keyword,
Keyword2, Markup,
Method, Monospace, NewText, Number, OldText, Preprocess, Region, ShellVariable, String, Target, Type, or Type2.
</p>
</li>
</ul></div>
<div class="paragraph"><p>Changes to language files in the custom directory take effect while Studio is running (although you may have to scroll
to see them).</p></div>
<div class="paragraph"><p><a href="mailto:jesse9jones@gmail.com">jesse9jones@gmail.com</a></p></div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2011-10-08 08:07:48 PDT
</div>
</div>
</body>
</html>