<!DOCTYPE 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>SpongeDocs Writing — Sponge 6.0.0 documentation</title>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/spongedocs.css" type="text/css" />
<link rel="index" title="Index"
href="../genindex.html"/> <link rel="search" title="Search" href="../search.html"/> <link rel="top" title="Sponge 6.0.0 documentation" href="../index.html"/> <link rel="up" title="Contributing to Sponge" href="index.html"/> <link rel="next" title="Porting Sponge to Other Platforms" href="porting.html"/> <link rel="prev" title="Implementing DataManipulators" href="implementation/datamanipulator.html"/>
<!-- Google Analytics -->
<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');
ga('create', 'UA-59476017-2', 'auto');
ga('send', 'pageview');
</script>
<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">
<div id="sp-logo-container" class="page-scroll">
<a class="logo" href="../index.html">
<img src="../_static/spongie-mark-dark.svg">
<span>Sponge</span>
<i class="fa fa-fw fa-chevron-down"></i>
</a>
<div id="sp-logo-menu">
<ul id="sp-logo-dropdown">
<li><a href="https://www.spongepowered.org"><i class="fa-fw fa fa-home"></i>Homepage</a></li>
<li><a href="https://forums.spongepowered.org"><i class="fa-fw fa fa-comments"></i>Forums</a></li>
<li><a href="https://github.com/SpongePowered"><i class="fa-fw fa fa-code"></i>Code</a></li>
<li class="active"><a href="https://docs.spongepowered.org"><i class="fa-fw fa fa-book"></i>Docs</a></li>
<li><a href="https://jd.spongepowered.org"><i class="fa-fw fa fa-graduation-cap"></i>Javadocs</a></li>
<li><a href="https://forums.spongepowered.org/c/plugins/plugin-releases"><i class="fa-fw fa fa-plug"></i>Plugins</a></li>
<li><a href="https://www.spongepowered.org/downloads"><i class="fa-fw fa fa-download"></i>Downloads</a></li>
<li><a href="https://www.spongepowered.org/chat"><i class="fa-fw fa fa-comment"></i>Chat</a></li>
</ul>
</div>
</div>
<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">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../server/index.html">Creating a Server</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../preparing/index.html">Preparing for Development</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../plugin/index.html">Creating a Plugin</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../ore/index.html">Ore Documentation</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Contributing to Sponge</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="guidelines.html">Contribution Guidelines</a></li>
<li class="toctree-l2"><a class="reference internal" href="howtogit.html">How to Git(Hub)</a></li>
<li class="toctree-l2"><a class="reference internal" href="implementation/index.html">Developing Sponge</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">SpongeDocs Writing</a></li>
<li class="toctree-l2"><a class="reference internal" href="porting.html">Porting Sponge to Other Platforms</a></li>
<li class="toctree-l2"><a class="reference internal" href="versioning.html">Versioning System and Repository Branch Layout</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../about/index.html">About the Sponge Project</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">Sponge</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><a href="index.html">Contributing to Sponge</a> »</li>
<li>SpongeDocs Writing</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/SpongePowered/SpongeDocs/blob/minor-fixes-ocd/source/contributing/spongedocs.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="spongedocs-writing">
<h1>SpongeDocs Writing<a class="headerlink" href="#spongedocs-writing" title="Permalink to this headline">¶</a></h1>
<p>The Sponge documentation, also referred to as “SpongeDocs”, is the official documentation of the Sponge project. The
goal of SpongeDocs is to:</p>
<ul class="simple">
<li>Help users set up their own servers powered by a Sponge implementation.</li>
<li>Provide developers with information on how to contribute to the Sponge project.</li>
<li>Provide developers with information on how to get started with plugin development.</li>
</ul>
<div class="section" id="reporting-problems">
<h2>Reporting Problems<a class="headerlink" href="#reporting-problems" title="Permalink to this headline">¶</a></h2>
<p>It may always occur that a page gets outdated, an error sneaks in or you just look at a page and think “Well, there is a
better way of explaining this.” If that is the case and you are for some reason not able to provide a fix yourself,
there are three ways of making us aware of the problem:</p>
<ol class="arabic simple">
<li>Create an <a class="reference external" href="https://github.com/SpongePowered/SpongeDocs/issues">Issue on the SpongeDocs GitHub</a></li>
<li>Create a Posting on the <a class="reference external" href="https://forums.spongepowered.org/c/sponge-docs">SpongeDocs Forums Category</a></li>
<li>Visit us in the <a class="reference external" href="ircs://irc.esper.net:6697/#spongedocs">#spongedocs channel on irc.esper.net</a> (you need to be registered)</li>
</ol>
</div>
<div class="section" id="writing-the-docs">
<h2>Writing the Docs<a class="headerlink" href="#writing-the-docs" title="Permalink to this headline">¶</a></h2>
<p>Changes and additions to SpongeDocs should be submitted as a pull request to the <a class="reference external" href="https://github.com/SpongePowered/SpongeDocs">SpongeDocs repository on GitHub</a>. We do not require it to be perfect right away as it is common for pull
requests to be refined during the review process. Incomplete explanations are also welcome, so don’t shy away if there
are some parts you do not understand. There will always be someone able to fill in the gaps.</p>
<p>The Docs are written in reStructuredText (reST), if you’re familiar with Markdown (md) the step to reST shouldn’t be to
hard. If you’re having issues with it we suggest that you join our <a class="reference external" href="https://forums.spongepowered.org/">forums</a> or
<a class="reference external" href="ircs://irc.esper.net:6697/#spongedocs">#SpongeDocs</a> on Esper.net and ask for help there.</p>
</div>
<div class="section" id="style-guide">
<h2>Style Guide<a class="headerlink" href="#style-guide" title="Permalink to this headline">¶</a></h2>
<p>To make sure we have consistent format across all SpongeDocs pages, here are the guidelines we have developed for
writing Sponge Documentation. This list may get added to (or bent out of shape) as the Docs get bigger.</p>
<ol class="arabic simple">
<li>Headings Should Be Written in Title Case (<- example) [unless #8 applies].</li>
<li>Page headings should be meaningful (the heading appears as a link).</li>
<li>Program code should be contained in <a class="reference external" href="http://docutils.sourceforge.net/docs/ref/rst/roles.html#literal">inline literals</a>
or code blocks.</li>
</ol>
<blockquote>
<div><ol class="lowerroman simple">
<li>Try not to put too much text in code blocks, as they cannot be translated.
Contributors are discouraged from commenting in code blocks wherever possible. Simple place-holder text may be
necessary in some examples. Ideally, code block examples will be short, and followed by an explanation for each
example in the body text. Of course, there may be some concepts that cannot be illustrated with a short example.</li>
</ol>
</div></blockquote>
<ol class="arabic simple" start="4">
<li>Keep separate areas for Users, Plugin Devs, and Sponge Devs.</li>
<li>Avoid repetition by sharing pages where possible.</li>
<li>Link to external resources rather than reproduce them.</li>
</ol>
<blockquote>
<div><ol class="lowerroman simple">
<li>Some exceptions are made for translation purposes.</li>
</ol>
</div></blockquote>
<ol class="arabic simple" start="7">
<li>Make distinction between SpongeForge, SpongeVanilla and SpongeAPI.</li>
<li>If it looks awful in your language, invent your own rules.</li>
<li>Sponge is the Project Title and should NOT be translated.</li>
</ol>
<blockquote>
<div><ol class="lowerroman simple">
<li>Some languages may wish to use a phonetic translation as well.</li>
</ol>
</div></blockquote>
<ol class="arabic simple" start="10">
<li>Automated translations (eg. Google Translate) are strongly discouraged. These often contain serious errors, and are
very likely to be rejected.</li>
<li>Page Titles and Section Headings should be plain text, avoiding literal blocks and other formatting.</li>
<li>Code symbols should be capitalised in their original form and have no extra spaces (eg. blockState (a field name) or
BlockState (a class name), rather than <em>block state</em>). They should also be formatted as a literal using double
backticks (eg. <code class="docutils literal"><span class="pre">blockState</span></code>) in body text.</li>
<li>Lines should have a maximum length of 120 characters.</li>
<li>Imports should be written out in code blocks the first time they are referenced in each article, but not repeated
after the first time.</li>
</ol>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">As Sponge is still in a state of flux, a shortfall of development docs is to be expected. Until official release of
Sponge, there are sure to be voids in many subjects. Nevertheless, SpongeDocs is a living document, always subject
to edit. It’s never going to be perfect, just beaten into shape as needs demand.</p>
</div>
<p><em>Contributions, suggestions and corrections are always welcome.</em></p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="porting.html" class="btn btn-neutral float-right" title="Porting Sponge to Other Platforms" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="implementation/datamanipulator.html" class="btn btn-neutral" title="Implementing DataManipulators" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2014-2017, Sponge 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>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<i class="fa fa-book"> <span>SpongeDocs</span></i>
v: 6.0.0
<span class="fa fa-caret-down"></span>
</span>
<div id="versions" class="rst-other-versions">
<dl>
<dt>Contribute</dt>
<dd><a href="https://github.com/SpongePowered/SpongeDocs/blob/minor-fixes-ocd/source/contributing/spongedocs.rst">Source</a></dd>
<dd><a href="https://github.com/SpongePowered/SpongeDocs/edit/minor-fixes-ocd/source/contributing/spongedocs.rst">Edit</a></dd>
</dl>
</div>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
VERSION:'6.0.0',
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/spongedocs.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>