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
|
---
title: Documentation
---
"*Getting Started*":get-started.html
Are you brand new to parslet? Well then let's introduce you guys. This is what
you should read and try out first.
There's also a "video version":https://www.youtube.com/watch?v=_F-eh66zw90!
"*Examples*":https://github.com/kschiess/parslet/tree/master/example/
Parslet comes with a lot of examples that explain how to use various aspects.
Take a look at those.
"*In depth*":overview.html
This is the real technical documentation, showing you how to use all aspects
of parslet. Especially:
* "Overview":overview.html explains parslet's goals and gives you a bigger
picture.
* Using "Parslet::Parser":parser.html to *write parsers*.
* Using "Parslet::Transform":transform.html to *transmogrify your intermediary
trees*.
* "Tricks":tricks.html for common situations.
*Projects*
There is a "Projects page":projects.html with everything from JSON through Java
to Ruby parsed with parslet.
*Presentations*
* "Parslet, An Introduction":https://docs.google.com/present/view?id=0AfXgUAUtzyc7ZGZrcG1mNXNfMzIwZ3JjY2c3NW0
introduces parslet in a few poignant slides. (Bo Jeanes and David Pick)
*Videos*
* "Writing DSL's with Parslet":http://www.confreaks.com/videos/2730-wickedgoodruby-writing-dsl-s-with-parslet
Talk given by Jason Garber at the "Wicked Good Ruby Conference 2013.
*Blogs*
* "Parslet Intro":http://florianhanke.com/blog/2011/02/01/parslet-intro.html
explains quite a few things on how parsers work and on parser
metaprogramming. Besides, Florian Hanke also explains how to create an ERB
parser in just a few lines!
* "Parslet and
JSON":http://jmettraux.wordpress.com/2011/05/11/parslet-and-json/ shows how
to construct a JSON parser in a few lines.
"John":http://jmettraux.wordpress.com/about/ does a great job of explaining
how parslet ties back in with railroad diagrams.
* "Parsing TOML in Ruby with Parslet":http://zerowidth.com/2013/02/24/parsing-toml-in-ruby-with-parslet.html
shows how to parse TOML ("Tom's Obvious Minimal Language":https://github.com/mojombo/toml)
using parslet. I sense a theme here. Code is on github - this is the first
article in a series, linked from the article.
* "Write You a Parser for Fun and Win":http://viget.com/extend/write-you-a-parser-for-fun-and-win
a succinct writeup on parsing text formats by David Eisinger.
* "Build a query parser":http://www.recursion.org/query-parser/
a step-by-step tutorial showing how to take user input and generate Elasticsearch queries by Luke Francl.
"*YARD Class Documentation*":http://rubydoc.info/gems/parslet/frames
The "YARD documentation":http://rubydoc.info/gems/parslet/frames 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.)
|