mirror of https://github.com/mpastell/Weave.jl
400 lines
13 KiB
HTML
400 lines
13 KiB
HTML
![]() |
<!DOCTYPE html>
|
||
|
<!--[if lt IE 7 ]><html class="no-js ie6"><![endif]-->
|
||
|
<!--[if IE 7 ]><html class="no-js ie7"><![endif]-->
|
||
|
<!--[if IE 8 ]><html class="no-js ie8"><![endif]-->
|
||
|
<!--[if IE 9 ]><html class="no-js ie9"><![endif]-->
|
||
|
<!--[if (gt IE 9)|!(IE)]><!--> <html class="no-js"> <!--<![endif]-->
|
||
|
<head>
|
||
|
<meta charset="utf-8">
|
||
|
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
|
||
|
|
||
|
|
||
|
<title>Getting started - Weave.jl</title>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<meta name="author" content="Matti Pastell">
|
||
|
|
||
|
|
||
|
<meta property="og:url" content="None">
|
||
|
<meta property="og:title" content="Weave.jl">
|
||
|
<meta property="og:image" content="None/../">
|
||
|
<meta name="apple-mobile-web-app-title" content="Weave.jl">
|
||
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
||
|
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
|
||
|
|
||
|
|
||
|
<link rel="shortcut icon" type="image/x-icon" href="../assets/images/favicon-e565ddfa3b.ico">
|
||
|
<link rel="icon" type="image/x-icon" href="../assets/images/favicon-e565ddfa3b.ico">
|
||
|
<style>
|
||
|
@font-face {
|
||
|
font-family: 'Icon';
|
||
|
src: url('../assets/fonts/icon.eot?52m981');
|
||
|
src: url('../assets/fonts/icon.eot?#iefix52m981')
|
||
|
format('embedded-opentype'),
|
||
|
url('../assets/fonts/icon.woff?52m981')
|
||
|
format('woff'),
|
||
|
url('../assets/fonts/icon.ttf?52m981')
|
||
|
format('truetype'),
|
||
|
url('../assets/fonts/icon.svg?52m981#icon')
|
||
|
format('svg');
|
||
|
font-weight: normal;
|
||
|
font-style: normal;
|
||
|
}
|
||
|
</style>
|
||
|
<link rel="stylesheet" href="../assets/stylesheets/application-a422ff04cc.css">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Ubuntu:400,700|Ubuntu+Mono">
|
||
|
<style>
|
||
|
body, input {
|
||
|
font-family: 'Ubuntu', Helvetica, Arial, sans-serif;
|
||
|
}
|
||
|
pre, code {
|
||
|
font-family: 'Ubuntu Mono', 'Courier New', 'Courier', monospace;
|
||
|
}
|
||
|
</style>
|
||
|
|
||
|
|
||
|
<link rel="stylesheet" href="../assets/Documenter.css">
|
||
|
|
||
|
<script src="../assets/javascripts/modernizr-4ab42b99fd.js"></script>
|
||
|
|
||
|
</head>
|
||
|
|
||
|
|
||
|
|
||
|
<body class=" ">
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
<div class="backdrop">
|
||
|
<div class="backdrop-paper"></div>
|
||
|
</div>
|
||
|
<input class="toggle" type="checkbox" id="toggle-drawer">
|
||
|
<input class="toggle" type="checkbox" id="toggle-search">
|
||
|
<label class="toggle-button overlay" for="toggle-drawer"></label>
|
||
|
<header class="header">
|
||
|
<nav aria-label="Header">
|
||
|
<div class="bar default">
|
||
|
<div class="button button-menu" role="button" aria-label="Menu">
|
||
|
<label class="toggle-button icon icon-menu" for="toggle-drawer">
|
||
|
<span></span>
|
||
|
</label>
|
||
|
</div>
|
||
|
<div class="stretch">
|
||
|
<div class="title">
|
||
|
|
||
|
<span class="path">
|
||
|
|
||
|
</span>
|
||
|
|
||
|
Getting started
|
||
|
</div>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
<div class="button button-twitter" role="button" aria-label="Twitter">
|
||
|
<a href="https://twitter.com/mpastell" title="@mpastell on Twitter" target="_blank" class="toggle-button icon icon-twitter"></a>
|
||
|
</div>
|
||
|
|
||
|
|
||
|
<div class="button button-search" role="button" aria-label="Search">
|
||
|
<label class="toggle-button icon icon-search" title="Search" for="toggle-search"></label>
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="bar search">
|
||
|
<div class="button button-close" role="button" aria-label="Close">
|
||
|
<label class="toggle-button icon icon-back" for="toggle-search"></label>
|
||
|
</div>
|
||
|
<div class="stretch">
|
||
|
<div class="field">
|
||
|
<input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck>
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="button button-reset" role="button" aria-label="Search">
|
||
|
<button class="toggle-button icon icon-close" id="reset-search"></button>
|
||
|
</div>
|
||
|
</div>
|
||
|
</nav>
|
||
|
</header>
|
||
|
<main class="main">
|
||
|
|
||
|
<div class="drawer">
|
||
|
<nav aria-label="Navigation">
|
||
|
|
||
|
<a href="https://github.com/mpastell/Weave.jl" class="project">
|
||
|
<div class="banner">
|
||
|
|
||
|
<div class="name">
|
||
|
<strong>
|
||
|
Weave.jl
|
||
|
<span class="version">
|
||
|
v0.4.1
|
||
|
</span>
|
||
|
</strong>
|
||
|
|
||
|
<br>
|
||
|
mpastell/Weave.jl
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
</a>
|
||
|
<div class="scrollable">
|
||
|
<div class="wrapper">
|
||
|
|
||
|
<ul class="repo">
|
||
|
<li class="repo-download">
|
||
|
|
||
|
<a href="https://github.com/mpastell/Weave.jl/archive/v0.4.1.zip" target="_blank" title="Download" data-action="download">
|
||
|
<i class="icon icon-download"></i> Download
|
||
|
</a>
|
||
|
</li>
|
||
|
<li class="repo-stars">
|
||
|
<a href="https://github.com/mpastell/Weave.jl/stargazers" target="_blank" title="Stargazers" data-action="star">
|
||
|
<i class="icon icon-star"></i> Stars
|
||
|
<span class="count">–</span>
|
||
|
</a>
|
||
|
</li>
|
||
|
</ul>
|
||
|
<hr>
|
||
|
|
||
|
<div class="toc">
|
||
|
<ul>
|
||
|
|
||
|
|
||
|
<li>
|
||
|
<a class="" title="Home" href="..">
|
||
|
Home
|
||
|
</a>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
|
||
|
|
||
|
<li>
|
||
|
<a class="current" title="Getting started" href="./">
|
||
|
Getting started
|
||
|
</a>
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
</li>
|
||
|
|
||
|
|
||
|
|
||
|
<li>
|
||
|
<a class="" title="Using Weave" href="../usage/">
|
||
|
Using Weave
|
||
|
</a>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
|
||
|
|
||
|
<li>
|
||
|
<a class="" title="Publishing scripts" href="../publish/">
|
||
|
Publishing scripts
|
||
|
</a>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
|
||
|
|
||
|
<li>
|
||
|
<a class="" title="Chunk options" href="../chunk_options/">
|
||
|
Chunk options
|
||
|
</a>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
|
||
|
|
||
|
<li>
|
||
|
<a class="" title="Working with Jupyter notebooks" href="../notebooks/">
|
||
|
Working with Jupyter notebooks
|
||
|
</a>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
|
||
|
|
||
|
<li>
|
||
|
<a class="" title="Function index" href="../function_index/">
|
||
|
Function index
|
||
|
</a>
|
||
|
|
||
|
</li>
|
||
|
|
||
|
|
||
|
</ul>
|
||
|
|
||
|
<hr>
|
||
|
<span class="section">The author</span>
|
||
|
<ul>
|
||
|
|
||
|
|
||
|
<li>
|
||
|
<a href="https://twitter.com/mpastell" target="_blank" title="@mpastell on Twitter">
|
||
|
@mpastell on Twitter
|
||
|
</a>
|
||
|
</li>
|
||
|
|
||
|
|
||
|
</ul>
|
||
|
|
||
|
</div>
|
||
|
</div>
|
||
|
</div>
|
||
|
</nav>
|
||
|
</div>
|
||
|
<article class="article">
|
||
|
<div class="wrapper">
|
||
|
|
||
|
<p><a id='Getting-started-1'></a></p>
|
||
|
<h1 id="getting-started">Getting started</h1>
|
||
|
<p>The best way to get started using Weave.jl is to look at the example input and output documents. Examples for different formats are included in the packages <code>examples</code> directory.</p>
|
||
|
<p>First have a look at source document using markdown code chunks and Gadfly for figures: <a href="../examples/gadfly_md_sample.jmd">gadfly_md_sample.jmd</a> and then see the output in different formats:</p>
|
||
|
<ul>
|
||
|
<li>Pandoc markdown: <a href="../examples/gadfly_md_sample.txt">gadfly_md_sample.md</a></li>
|
||
|
<li>HTML: <a href="../examples/gadfly_md_sample.html">gadfly_md_sample.html</a></li>
|
||
|
<li>pdf: <a href="../examples/gadfly_md_sample.pdf">gadfly_md_sample.pdf</a></li>
|
||
|
</ul>
|
||
|
<p><em>Producing pdf output requires that you have pdflatex installed.</em></p>
|
||
|
<p>Add depencies for the example if needed:</p>
|
||
|
<div class="code"><pre><span></span><span class="n">Pkg</span><span class="o">.</span><span class="n">add</span><span class="o">.</span><span class="p">([</span><span class="s">"Cairo"</span><span class="p">,</span> <span class="s">"Fontconfig"</span><span class="p">,</span> <span class="s">"Gadfly"</span><span class="p">])</span>
|
||
|
</pre></div>
|
||
|
|
||
|
|
||
|
<p>Weave the files to your working directory using:</p>
|
||
|
<div class="code"><pre><span></span><span class="k">using</span> <span class="n">Weave</span>
|
||
|
<span class="c">#Markdown</span>
|
||
|
<span class="n">weave</span><span class="p">(</span><span class="n">Pkg</span><span class="o">.</span><span class="n">dir</span><span class="p">(</span><span class="s">"Weave"</span><span class="p">,</span><span class="s">"examples"</span><span class="p">,</span><span class="s">"gadfly_md_sample.jmd"</span><span class="p">),</span> <span class="n">out_path</span> <span class="o">=</span> <span class="o">:</span><span class="n">pwd</span><span class="p">,</span>
|
||
|
<span class="n">doctype</span> <span class="o">=</span> <span class="s">"pandoc"</span><span class="p">)</span>
|
||
|
<span class="c">#HTML</span>
|
||
|
<span class="n">weave</span><span class="p">(</span><span class="n">Pkg</span><span class="o">.</span><span class="n">dir</span><span class="p">(</span><span class="s">"Weave"</span><span class="p">,</span><span class="s">"examples"</span><span class="p">,</span><span class="s">"gadfly_md_sample.jmd"</span><span class="p">),</span> <span class="n">out_path</span> <span class="o">=</span> <span class="o">:</span><span class="n">pwd</span><span class="p">,</span>
|
||
|
<span class="n">doctype</span> <span class="o">=</span> <span class="s">"md2html"</span><span class="p">)</span>
|
||
|
<span class="c">#pdf</span>
|
||
|
<span class="n">weave</span><span class="p">(</span><span class="n">Pkg</span><span class="o">.</span><span class="n">dir</span><span class="p">(</span><span class="s">"Weave"</span><span class="p">,</span><span class="s">"examples"</span><span class="p">,</span><span class="s">"gadfly_md_sample.jmd"</span><span class="p">),</span> <span class="n">out_path</span> <span class="o">=</span> <span class="o">:</span><span class="n">pwd</span><span class="p">,</span>
|
||
|
<span class="n">doctype</span> <span class="o">=</span> <span class="s">"md2pdf"</span><span class="p">)</span>
|
||
|
</pre></div>
|
||
|
<aside class="copyright" role="note">
|
||
|
|
||
|
Matti Pastell 2016 –
|
||
|
|
||
|
Documentation built with
|
||
|
<a href="http://www.mkdocs.org" target="_blank">MkDocs</a>
|
||
|
using the
|
||
|
<a href="http://squidfunk.github.io/mkdocs-material/" target="_blank">
|
||
|
Material
|
||
|
</a>
|
||
|
theme.
|
||
|
</aside>
|
||
|
|
||
|
<footer class="footer">
|
||
|
|
||
|
<nav class="pagination" aria-label="Footer">
|
||
|
<div class="previous">
|
||
|
|
||
|
<a href=".." title="Home">
|
||
|
<span class="direction">
|
||
|
Previous
|
||
|
</span>
|
||
|
<div class="page">
|
||
|
<div class="button button-previous" role="button" aria-label="Previous">
|
||
|
<i class="icon icon-back"></i>
|
||
|
</div>
|
||
|
<div class="stretch">
|
||
|
<div class="title">
|
||
|
Home
|
||
|
</div>
|
||
|
</div>
|
||
|
</div>
|
||
|
</a>
|
||
|
|
||
|
</div>
|
||
|
<div class="next">
|
||
|
|
||
|
<a href="../usage/" title="Using Weave">
|
||
|
<span class="direction">
|
||
|
Next
|
||
|
</span>
|
||
|
<div class="page">
|
||
|
<div class="stretch">
|
||
|
<div class="title">
|
||
|
Using Weave
|
||
|
</div>
|
||
|
</div>
|
||
|
<div class="button button-next" role="button" aria-label="Next">
|
||
|
<i class="icon icon-forward"></i>
|
||
|
</div>
|
||
|
</div>
|
||
|
</a>
|
||
|
|
||
|
</div>
|
||
|
</nav>
|
||
|
|
||
|
</footer>
|
||
|
|
||
|
</div>
|
||
|
</article>
|
||
|
<div class="results" role="status" aria-live="polite">
|
||
|
<div class="scrollable">
|
||
|
<div class="wrapper">
|
||
|
<div class="meta"></div>
|
||
|
<div class="list"></div>
|
||
|
</div>
|
||
|
</div>
|
||
|
</div>
|
||
|
</main>
|
||
|
<script>
|
||
|
var base_url = '..';
|
||
|
var repo_id = 'mpastell/Weave.jl';
|
||
|
</script>
|
||
|
<script src="../assets/javascripts/application-997097ee0c.js"></script>
|
||
|
|
||
|
<script src="../assets/mathjaxhelper.js"></script>
|
||
|
|
||
|
|
||
|
<script>
|
||
|
(function(i,s,o,g,r,a,m){
|
||
|
i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||
|
||
|
[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;
|
||
|
m.parentNode.insertBefore(a,m)
|
||
|
})(window, document,
|
||
|
'script', 'https://www.google-analytics.com/analytics.js', 'ga');
|
||
|
/* General initialization */
|
||
|
ga('create', 'UA-6474352-10', 'auto');
|
||
|
ga('set', 'anonymizeIp', true);
|
||
|
ga('send', 'pageview');
|
||
|
/* Track outbound links */
|
||
|
var buttons = document.querySelectorAll('a');
|
||
|
Array.prototype.map.call(buttons, function(item) {
|
||
|
if (item.host != document.location.host) {
|
||
|
item.addEventListener('click', function() {
|
||
|
var action = item.getAttribute('data-action') || 'follow';
|
||
|
ga('send', 'event', 'outbound', action, item.href);
|
||
|
});
|
||
|
}
|
||
|
});
|
||
|
/* Register handler to log search on blur */
|
||
|
var query = document.querySelector('.query');
|
||
|
query.addEventListener('blur', function() {
|
||
|
if (this.value) {
|
||
|
var path = document.location.pathname;
|
||
|
ga('send', 'pageview', path + '?q=' + this.value);
|
||
|
}
|
||
|
});
|
||
|
</script>
|
||
|
|
||
|
</body>
|
||
|
</html>
|