Author: jfarrell
Date: Wed May 15 03:59:38 2013
New Revision: 1482667
URL: http://svn.apache.org/r1482667
Log:
Updating Apache Thrift website with graphiz generator tutorial
Added:
thrift/site/content/tutorial/graphiz.md
thrift/site/publish/tutorial/graphiz/
thrift/site/publish/tutorial/graphiz/index.html
Modified:
thrift/site/publish/sitemap/index.html
thrift/site/publish/tutorial/index.html
Added: thrift/site/content/tutorial/graphiz.md
URL:
http://svn.apache.org/viewvc/thrift/site/content/tutorial/graphiz.md?rev=1482667&view=auto
==============================================================================
--- thrift/site/content/tutorial/graphiz.md (added)
+++ thrift/site/content/tutorial/graphiz.md Wed May 15 03:59:38 2013
@@ -0,0 +1,37 @@
+---
+title: "Graphiz"
+library_lang: "cpp"
+---
+<%= render 'tutorial_intro' %>
+
+### Prerequisites
+* A Graphviz renderer
+
+ The [official renderers](http://www.graphviz.org/) can be used as a
command line tool to produce a graphic from the '.gv' file
+
+### Overview
+
+The Graphviz generator is a convenient way to generate documentation diagrams
+for your API. Usage:
+
+ $ thrift --gen gv tutorial.thrift
+
+This will create the file 'gen-gv/tutorial.gv', which is a [Graphiz
+source](http://en.wikipedia.org/wiki/DOT_(graph_description_language)) - a
+plain-text description language used for graphs (in this case, for IDL's types
+and functions diagram). You will need to actually render those graphs into any
+of the supported output formats (e.g. PNG, PDFs, SVG, etc.) by using a Graphiz
+renderer in your platform.
+
+ $ dot -Tpdf -otutorial.pdf gen-gv/tutorial.gv
+
+### Extra options
+
+By default, the diagrams are not rendered with arrows from functions to
+exceptions (although the exception structures are displayed). You can set the
+generator to render those exceptions arrows (i.e. function throws) by using the
+`exception` option:
+
+ $ thrift --gen:gv:exceptions gv tutorial.thrift
+
+
Modified: thrift/site/publish/sitemap/index.html
URL:
http://svn.apache.org/viewvc/thrift/site/publish/sitemap/index.html?rev=1482667&r1=1482666&r2=1482667&view=diff
==============================================================================
--- thrift/site/publish/sitemap/index.html (original)
+++ thrift/site/publish/sitemap/index.html Wed May 15 03:59:38 2013
@@ -95,7 +95,7 @@
<li>
<a href="/tutorial/">Tutorial</a><ul>
-<li><a href="/tutorial/as3/">As3</a></li> <li><a href="/tutorial/c_glib/">C
Glib</a></li> <li><a href="/tutorial/cpp/">C++</a></li> <li><a
href="/tutorial/csharp/">CSharp</a></li> <li><a href="/tutorial/d/">D</a></li>
<li><a href="/tutorial/delphi/">Delphi</a></li> <li><a
href="/tutorial/erl/">Erlang</a></li> <li><a
href="/tutorial/go/">Go</a></li> <li><a href="/tutorial/hs/">Haskell</a></li>
<li><a href="/tutorial/java/">Java</a></li> <li><a
href="/tutorial/javame/">Java Me</a></li> <li><a
href="/tutorial/js/">Javascript</a></li> <li><a
href="/tutorial/nodejs/">Node.js</a></li> <li><a
href="/tutorial/cocoa/">Objective-c</a></li> <li><a
href="/tutorial/ocaml/">OCaml</a></li> <li><a
href="/tutorial/perl/">Perl</a></li> <li><a href="/tutorial/php/">PHP</a></li>
<li><a href="/tutorial/py/">Python</a></li> <li><a
href="/tutorial/rb/">Ruby</a></li> <li><a
href="/tutorial/st/">Smalltalk</a></li>
+<li><a href="/tutorial/as3/">As3</a></li> <li><a href="/tutorial/c_glib/">C
Glib</a></li> <li><a href="/tutorial/cpp/">C++</a></li> <li><a
href="/tutorial/csharp/">CSharp</a></li> <li><a href="/tutorial/d/">D</a></li>
<li><a href="/tutorial/delphi/">Delphi</a></li> <li><a
href="/tutorial/erl/">Erlang</a></li> <li><a
href="/tutorial/go/">Go</a></li> <li><a
href="/tutorial/graphiz/">Graphiz</a></li> <li><a
href="/tutorial/hs/">Haskell</a></li> <li><a
href="/tutorial/java/">Java</a></li> <li><a href="/tutorial/javame/">Java
Me</a></li> <li><a href="/tutorial/js/">Javascript</a></li> <li><a
href="/tutorial/nodejs/">Node.js</a></li> <li><a
href="/tutorial/cocoa/">Objective-c</a></li> <li><a
href="/tutorial/ocaml/">OCaml</a></li> <li><a
href="/tutorial/perl/">Perl</a></li> <li><a href="/tutorial/php/">PHP</a></li>
<li><a href="/tutorial/py/">Python</a></li> <li><a
href="/tutorial/rb/">Ruby</a></li> <li><a
href="/tutorial/st/">Smalltalk</a></li>
</ul>
</li>
Added: thrift/site/publish/tutorial/graphiz/index.html
URL:
http://svn.apache.org/viewvc/thrift/site/publish/tutorial/graphiz/index.html?rev=1482667&view=auto
==============================================================================
--- thrift/site/publish/tutorial/graphiz/index.html (added)
+++ thrift/site/publish/tutorial/graphiz/index.html Wed May 15 03:59:38 2013
@@ -0,0 +1,151 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
+ <head>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+ <meta content="en-us" http-equiv="Content-Language" />
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <link href="/static/images/favicon.ico" rel="shortcut icon" />
+ <link href="/static/css/style.css" rel="stylesheet" type="text/css" />
+ <link href="/static/css/bootstrap.css" media="screen, projection"
rel="stylesheet" type="text/css" />
+
+ <script src="/static/js/jquery.min.js"></script>
+ <script src="/static/js/bootstrap-dropdown.js"></script>
+ <script src="/static/js/bootstrap-tab.js"></script>
+
+ <title>Apache Thrift</title>
+ </head>
+ <body>
+ <div class="navbar">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="http://thrift.apache.org";>Apache
Thrift ™</a>
+ <div class="nav-collapse">
+ <ul class="nav pull-right">
+ <li>
+ <a
href="/download/">Download</a>
+ </li>
+ <li>
+ <a
href="/docs/">Documentation</a>
+ </li>
+ <li>
+ <a
href="/developers/">Developers</a>
+ </li>
+ <li>
+ <a
href="/tutorial/">Tutorials</a>
+ </li>
+ <li>
+ <a href="/about/">About</a>
+ </li>
+ <li class="dropdown">
+ <a href="#"
class="dropdown-toggle" data-toggle="dropdown">
+ Apache <b
class="caret"></b>
+ </a>
+ <ul class="dropdown-menu">
+ <li>
+ <a
href="http://www.apache.org/"; target="_blank">Apache Home</a>
+ </li>
+ <li>
+ <a
href="http://www.apache.org/licenses/"; target="_blank">Apache License v2.0</a>
+ </li>
+ <li>
+ <a
href="http://www.apache.org/foundation/sponsorship.html";
target="_blank">Donate</a>
+ </li>
+ <li>
+ <a
href="http://www.apache.org/foundation/thanks.html"; target="_blank">Thanks</a>
+ </li>
+ <li>
+ <a
href="http://www.apache.org/security/"; target="_blank">Security</a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+</div>
+
+ <div class="container">
+ <h2>Graphiz Tutorial</h2>
+
+<hr><h3>Introduction</h3>
+
+<p>All Apache Thrift tutorials require that you have:</p>
+
+<ol>
+<li>Built and installed the Apache Thrift Compiler, see <a
href="/docs/install/">installing Thrift</a> for more details. </li>
+<li>
+<p>Generated the <a
href="https://git-wip-us.apache.org/repos/asf?p=thrift.git;a=blob_plain;f=tutorial/tutorial.thrift";>tutorial.thrift</a>
file as <a href="/tutorial/">discussed here</a></p>
+
+<pre><code>thrift --gen cpp tutorial.thrift
+</code></pre>
+</li>
+<li><p>Followed all prerequesets listed </p></li>
+</ol><h3>Prerequisites</h3>
+
+<ul>
+<li>
+<p>A Graphviz renderer</p>
+
+<p>The <a href="http://www.graphviz.org/";>official renderers</a> can be used
as a command line tool to produce a graphic from the '.gv' file</p>
+</li>
+</ul><h3>Overview</h3>
+
+<p>The Graphviz generator is a convenient way to generate documentation
diagrams
+for your API. Usage:</p>
+
+<pre><code>$ thrift --gen gv tutorial.thrift
+</code></pre>
+
+<p>This will create the file 'gen-gv/tutorial.gv', which is a <a
href="http://en.wikipedia.org/wiki/DOT_(graph_description_language">Graphiz
+source</a>) - a
+plain-text description language used for graphs (in this case, for IDL's types
+and functions diagram). You will need to actually render those graphs into any
+of the supported output formats (e.g. PNG, PDFs, SVG, etc.) by using a Graphiz
+renderer in your platform.</p>
+
+<pre><code>$ dot -Tpdf -otutorial.pdf gen-gv/tutorial.gv
+</code></pre>
+
+<h3>Extra options</h3>
+
+<p>By default, the diagrams are not rendered with arrows from functions to
+exceptions (although the exception structures are displayed). You can set the
+generator to render those exceptions arrows (i.e. function throws) by using the
+<code>exception</code> option:</p>
+
+<pre><code>$ thrift --gen:gv:exceptions gv tutorial.thrift
+</code></pre>
+ </div>
+ <div class="container">
+ <hr>
+ <footer class="footer">
+ <div class="row">
+ <div class="span3">
+ <h3>Links</h3>
+ <ul class="unstyled">
+ <li><a
href="/download/">Download</a></li>
+ <li><a
href="/developers/">Developers</a></li>
+ <li><a
href="/tutorial/">Tutorials</a></li>
+ </ul>
+ <ul class="unstyled">
+ <li><a href="/sitemap/">Sitemap</a></li>
+ </ul>
+ </div>
+ <div class="span3">
+ <h3>Get Involved</h3>
+ <ul class="unstyled">
+ <li><a href="/mailing/">Mailing
Lists</a></li>
+ <li><a
href="http://issues.apache.org/jira/browse/THRIFT";>Issue Tracking</a></li>
+ <li><a
href="/docs/HowToContribute/">How To Contribute</a></li>
+ </ul>
+ </div>
+ <div class="span6">
+ <a href="http://www.apache.org/";><img
src="/static/images/favicon.ico" /></a> Copyright 2012 <a
href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under
the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. Apache,
Apache Thrift, and the Apache feather logo are trademarks of The Apache
Software Foundation.
+ </div>
+ </div>
+
+ </footer>
+</div>
+ </body>
+</html>
Modified: thrift/site/publish/tutorial/index.html
URL:
http://svn.apache.org/viewvc/thrift/site/publish/tutorial/index.html?rev=1482667&r1=1482666&r2=1482667&view=diff
==============================================================================
--- thrift/site/publish/tutorial/index.html (original)
+++ thrift/site/publish/tutorial/index.html Wed May 15 03:59:38 2013
@@ -130,6 +130,10 @@
</li>
<li>
+ <a href="/tutorial/graphiz/">Graphiz</a>
+ </li>
+
+ <li>
<a href="/tutorial/hs/">Haskell</a>
</li>
