carto
Version:
Mapnik Stylesheet Compiler
297 lines (191 loc) • 9.75 kB
HTML
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Installation & Usage — carto documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="index" title="Index"
href="genindex.html"/>
<link rel="search" title="Search" href="search.html"/>
<link rel="top" title="carto documentation" href="index.html"/>
<link rel="next" title="Language Elements" href="language_elements.html"/>
<link rel="prev" title="CartoCSS" href="index.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> carto
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation & Usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#usage">Usage</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="language_elements.html">Language Elements</a></li>
<li class="toctree-l1"><a class="reference internal" href="styling_concepts.html">Styling Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="mapnik_api.html">Mapnik API documentation</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">carto</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Installation & Usage</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/installation_usage.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="installation-usage">
<h1>Installation & Usage<a class="headerlink" href="#installation-usage" title="Permalink to this headline">¶</a></h1>
<div class="section" id="installation">
<h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<p>If you are using a map design application like Kosmtik, Mapbox Studio Classic or Tilemill you already have CartoCSS installed
and might be more interested in the language reference.</p>
<p>Else you can install the <em>carto</em> binary with NPM by running:</p>
<div class="highlight-default"><div class="highlight"><pre><span class="n">npm</span> <span class="n">install</span> <span class="o">-</span><span class="n">g</span> <span class="n">carto</span>
</pre></div>
</div>
<p>You should consider using a Node.js version manager like <a class="reference external" href="https://github.com/creationix/nvm">NVM</a>.</p>
<p>Optionally you may also want to install millstone which is required for resolving data in the same way as Mapbox Studio Classic does:</p>
<div class="highlight-default"><div class="highlight"><pre><span class="n">npm</span> <span class="n">install</span> <span class="o">-</span><span class="n">g</span> <span class="n">millstone</span>
</pre></div>
</div>
<p>Having <em>millstone</em> installed specifically enables support for localizing external resources (URLs and local files) referenced in your MML file,
and detecting projections (using <a class="reference external" href="https://github.com/mapbox/node-srs">node-srs</a>).</p>
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>Now that Carto is installed you should have a <em>carto</em> command line tool available that can be run on a CartoCSS project:</p>
<div class="highlight-default"><div class="highlight"><pre><span class="n">carto</span> <span class="n">project</span><span class="o">.</span><span class="n">mml</span> <span class="o">></span> <span class="n">mapnik</span><span class="o">.</span><span class="n">xml</span>
</pre></div>
</div>
<p>The following command line options are available:</p>
<dl class="docutils">
<dt>-a / –api VERSION</dt>
<dd>Specify Mapnik API version (e.g. –api 3.0.10) (default: latest Mapnik API version)</dd>
<dt>-b / –benchmark</dt>
<dd>Outputs total compile time</dd>
<dt>-h / –help</dt>
<dd>Display help message</dd>
<dt>-l / –localize</dt>
<dd>Use millstone to localize resources when loading an MML (default: off)</dd>
<dt>-n / –nosymlink</dt>
<dd>Use absolute paths instead of symlinking files</dd>
<dt>-ppi RESOLUTION</dt>
<dd>Pixels per inch used to convert m, mm, cm, in, pt, pc to pixels (default: 90.714)</dd>
<dt>-q / –quiet</dt>
<dd>Do not output any warnings (default: off)</dd>
<dt>-v / –version</dt>
<dd>Display version information</dd>
</dl>
<p>Alternatively, Carto can be used from JavaScript. The <em>Renderer</em> interface is the main API for developers,
and it takes an MML file as a string as input.</p>
<div class="highlight-default"><div class="highlight"><pre>// defined variables:
// - input (the name or identifier of the file being parsed)
var carto = require('carto');
try {
var data = fs.readFileSync(input, 'utf-8');
var mml = new carto.MML();
mml.load(path.dirname(input), data, function (err, data) {
var output = {};
if (!err) {
output = new carto.Renderer({
filename: input,
local_data_dir: path.dirname(input),
}).render(data);
}
if (output.msg) {
output.msg.forEach(function (v) {
if (v.type === 'error') {
console.error(carto.Util.getMessageToPrint(v));
}
else if (v.type === 'warning') {
console.warn(carto.Util.getMessageToPrint(v));
}
});
}
// output content (if no errors)
if (output.data) {
console.log(output.data);
}
});
} catch (err) {
// program failures
...
}
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If you want to use Carto within the browser you should not use MML loading via <code class="docutils literal"><span class="pre">carto.MML.load</span></code>.
Instead you should supply the JSON of the MML including the Stylesheet strings directly to <code class="docutils literal"><span class="pre">carto.Renderer.render</span></code>.</p>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="language_elements.html" class="btn btn-neutral float-right" title="Language Elements" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="CartoCSS" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, Carto contributors.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>