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
|
<!DOCTYPE html>
<html>
<head>
<meta content="text/html;charset=UTF-8" http-equiv="Content-type" />
<title>parslet - Documentation</title>
<meta content="Kaspar Schiess (http://absurd.li)" name="author" />
<link href="images/favicon3.ico" rel="shortcut icon" />
<link href="/parslet/stylesheets/site.css" rel="stylesheet" /><link href="/parslet/stylesheets/sh_whitengrey.css" rel="stylesheet" /><script src="http://code.jquery.com/jquery-2.1.4.min.js"></script><script src="/parslet/javascripts/toc.js"></script><script src="/parslet/javascripts/sh_main.min.js"></script><script src="/parslet/javascripts/sh_ruby.min.js"></script>
</head>
<body class="code" onload="sh_highlightDocument(); $('#toc').toc({selectors: 'h2'});">
<div id="everything">
<div class="main_menu">
<img src="/parslet/images/parsley_logo.png" alt="Parslet Logo" />
<ul>
<li>
<a href="/parslet/">about</a>
</li>
<li>
<a href="/parslet/get-started.html">get started</a>
</li>
<li>
<a href="/parslet/install.html">install</a>
</li>
<li>
<a href="/parslet/documentation.html">docs</a>
</li>
<li>
<a href="/parslet/contribute.html">contribute</a>
</li>
<li>
<a href="/parslet/projects.html">projects</a>
</li>
</ul>
</div>
<div class="content">
<h1>
Documentation
</h1>
<p><a href="get-started.html"><strong>Getting Started</strong></a></p>
<p>Are you brand new to parslet? Well then let’s introduce you guys. This is what
you should read and try out first.</p>
<p>There’s also a <a href="https://www.youtube.com/watch?v=_F-eh66zw90">video version</a>!</p>
<p><a href="https://github.com/kschiess/parslet/tree/master/example/"><strong>Examples</strong></a></p>
<p>Parslet comes with a lot of examples that explain how to use various aspects.
Take a look at those.</p>
<p><a href="overview.html"><strong>In depth</strong></a></p>
<p>This is the real technical documentation, showing you how to use all aspects
of parslet. Especially:</p>
<ul>
<li><a href="overview.html">Overview</a> explains parslet’s goals and gives you a bigger
picture.</li>
<li>Using <a href="parser.html">Parslet::Parser</a> to <strong>write parsers</strong>.</li>
<li>Using <a href="transform.html">Parslet::Transform</a> to <strong>transmogrify your intermediary
trees</strong>.</li>
<li><a href="tricks.html">Tricks</a> for common situations.</li>
</ul>
<p><strong>Projects</strong></p>
<p>There is a <a href="projects.html">Projects page</a> with everything from <span class="caps">JSON</span> through Java
to Ruby parsed with parslet.</p>
<p><strong>Presentations</strong></p>
<ul>
<li><a href="https://docs.google.com/present/view?id=0AfXgUAUtzyc7ZGZrcG1mNXNfMzIwZ3JjY2c3NW0">Parslet, An Introduction</a>
introduces parslet in a few poignant slides. (Bo Jeanes and David Pick)</li>
</ul>
<p><strong>Videos</strong></p>
<ul>
<li><a href="http://www.confreaks.com/videos/2730-wickedgoodruby-writing-dsl-s-with-parslet">Writing DSL’s with Parslet</a>
Talk given by Jason Garber at the "Wicked Good Ruby Conference 2013.</li>
</ul>
<p><strong>Blogs</strong></p>
<ul>
<li><a href="http://florianhanke.com/blog/2011/02/01/parslet-intro.html">Parslet Intro</a>
explains quite a few things on how parsers work and on parser
metaprogramming. Besides, Florian Hanke also explains how to create an <span class="caps">ERB</span>
parser in just a few lines!</li>
</ul>
<ul>
<li><a href="http://jmettraux.wordpress.com/2011/05/11/parslet-and-json/">Parslet and
<span class="caps">JSON</span></a> shows how
to construct a <span class="caps">JSON</span> parser in a few lines.
<a href="http://jmettraux.wordpress.com/about/">John</a> does a great job of explaining
how parslet ties back in with railroad diagrams.</li>
</ul>
<ul>
<li><a href="http://zerowidth.com/2013/02/24/parsing-toml-in-ruby-with-parslet.html">Parsing <span class="caps">TOML</span> in Ruby with Parslet</a>
shows how to parse <span class="caps">TOML</span> (<a href="https://github.com/mojombo/toml">Tom’s Obvious Minimal Language</a>)
using parslet. I sense a theme here. Code is on github – this is the first
article in a series, linked from the article.</li>
</ul>
<ul>
<li><a href="http://viget.com/extend/write-you-a-parser-for-fun-and-win">Write You a Parser for Fun and Win</a>
a succinct writeup on parsing text formats by David Eisinger.</li>
</ul>
<ul>
<li><a href="http://www.recursion.org/query-parser/">Build a query parser</a>
a step-by-step tutorial showing how to take user input and generate Elasticsearch queries by Luke Francl.</li>
</ul>
<p><a href="http://rubydoc.info/gems/parslet/frames"><strong><span class="caps">YARD</span> Class Documentation</strong></a></p>
<p>The <a href="http://rubydoc.info/gems/parslet/frames"><span class="caps">YARD</span> documentation</a> will help you
with the nitty gritty. This documentation is real important too. It will be
constantly improved! (Thanks linode.com and DockYard for sponsoring this tool.)</p>
</div>
<div class="copyright">
<p><span class="caps">MIT</span> License, 2010-2018, © <a href="http://absurd.li">Kaspar Schiess</a><br/></p>
</div>
<script>
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-16365074-2']);
_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>
</div>
</body>
</html>
|
