| <!DOCTYPE html><html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/> |
| <title>Apache Sling :: Documentation</title> |
| <link rel="icon" href="/favicon.ico"/> |
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/bulma/0.7.5/css/bulma.min.css"/> |
| <link rel="stylesheet" href="/res/css/site.css"/> |
| <script src='https://www.apachecon.com/event-images/snippet.js'></script><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/> |
| <script src='https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js'></script><script> |
| hljs.initHighlightingOnLoad(); |
| </script> |
| |
| <!-- Matomo Web Analytics --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| /* We explicitly disable cookie tracking to avoid privacy issues */ |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://matomo.privacy.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '6']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo Code --> |
| <link href='/pagefind/pagefind-ui.css' rel='stylesheet'><script src='/pagefind/pagefind-ui.js' type='text/javascript'></script> |
| <script> |
| window.addEventListener('DOMContentLoaded', (event) => { |
| new PagefindUI({ element: "#searchbox" }); |
| }); |
| </script> |
| |
| </head> <body> |
| <div class="section"> |
| <div class="level is-marginless"> |
| <div class="logo"> |
| <a href="https://sling.apache.org"> |
| <img border="0" alt="Apache Sling" src="/res/logos/sling.svg"/> |
| </a> |
| </div><div class="header"> |
| <a href="https://www.apache.org"> |
| <img border="0" alt="Apache" src="/res/logos/apache.png"/> |
| </a> |
| </div> |
| </div><section class="searchbox level is-marginless"> |
| <div id="searchbox"></div> |
| </section><div class="columns is-gapless"> |
| <div class="column is-narrow sidemenu"> |
| <div class="container"> |
| <nav class="menu"> |
| <ul class="menu-list box is-shadowless is-marginless"> |
| <li> |
| <p class="menu-label"> |
| <strong>Documentation</strong> |
| </p><ul> |
| <li><a href="/documentation.html">Overview</a></li><li><a href="/documentation/getting-started.html">Getting Started</a></li><li><a href="/documentation/the-sling-engine.html">The Sling Engine</a></li><li><a href="/documentation/development.html">Development</a></li><li><a href="/documentation/bundles.html">Bundles</a></li><li><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a></li><li><a href="/components/">Maven Plugins</a></li><li><a href="/documentation/configuration.html">Configuration</a></li> |
| </ul> |
| </li><li> |
| <p class="menu-label"> |
| <strong>API Docs</strong> |
| </p><ul> |
| <li><a href="/apidocs/sling12/index.html">Sling 12</a></li><li><a href="/apidocs/sling11/index.html">Sling 11</a></li><li><a href="/apidocs/sling10/index.html">Sling 10</a></li><li><a href="/apidocs/sling9/index.html">Sling 9</a></li><li><a href="/documentation/apidocs.html">All versions</a></li> |
| </ul> |
| </li><li> |
| <p class="menu-label"> |
| <strong>Support</strong> |
| </p><ul> |
| <li><a href="https://s.apache.org/sling.wiki">Wiki</a></li><li><a href="https://s.apache.org/sling.faq">FAQ</a></li><li><a href="/sitemap.html">Sitemap</a></li> |
| </ul> |
| </li><li> |
| <p class="menu-label"> |
| <strong>Project Info</strong> |
| </p><ul> |
| <li><a href="/downloads.cgi">Downloads</a></li><li><a href="https://www.apache.org/licenses/">License</a></li><li><a href="/news.html">News</a></li><li><a href="/releases.html">Releases</a></li><li><a href="https://issues.apache.org/jira/browse/SLING">Issue Tracker</a></li><li><a href="/links.html">Links</a></li><li><a href="/contributing.html">Contributing</a></li><li><a href="/project-information.html">Project Information</a></li><li><a href="/project-information/security.html">Security</a></li> |
| </ul> |
| </li><li> |
| <p class="menu-label"> |
| <strong>Source</strong> |
| </p><ul> |
| <li><a href="/repolist.html">Repositories</a></li><li><a href="https://gitbox.apache.org/repos/asf?s=sling">Git at Apache</a></li> |
| </ul> |
| </li><li> |
| <p class="menu-label"> |
| <strong>Apache Software<br>Foundation</strong> |
| </p><ul> |
| <li><a href="https://www.apache.org/foundation/thanks.html">Thanks!</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li><li><a href="https://www.apache.org/foundation/buy_stuff.html">Buy Stuff</a></li> |
| </ul> |
| </li><li> |
| <a class="acevent" data-format="square" data-event="random"></a> |
| </li><li> |
| <a href="https://apache.org/foundation/contributing.html" class="column"> |
| <img border="0" alt="Support the Apache Software Foundation!" src="/res/images/SupportApache-small.png" width="125"/> |
| </a> |
| </li> |
| </ul> |
| </nav> |
| </div> |
| </div><div class="column main"> |
| <div class="box is-shadowless is-marginless"> |
| <div class="level"> |
| <div class="pagenav"> |
| <div class="breadcrumb"> |
| <ul> |
| <li> |
| <a href="/"> |
| Home |
| </a> |
| </li> |
| </ul> |
| </div> |
| </div><div class="tags"> |
| <span class="tag"> |
| <a href="/tags/documentation.html"> |
| documentation |
| </a> |
| </span><span class="tag"> |
| <a href="/tags/community.html"> |
| community |
| </a> |
| </span><span class="tag"> |
| <a href="/tags/pmc.html"> |
| pmc |
| </a> |
| </span><span class="tag"> |
| <a href="/tags/modules.html"> |
| modules |
| </a> |
| </span> |
| </div> |
| </div><h1 class="title"> |
| Documentation |
| </h1><nav class="menu"> |
| <ul class="menu-list box is-shadowless is-paddingless"> |
| <li id="generatedToC"> |
| <p class="menu-label"> |
| <strong>Table of Contents</strong> |
| </p> |
| </li> |
| </ul> |
| </nav><script src='/res/jquery-3.2.1.min.js' type='text/javascript'></script><script src='/res/tocjs-1-1-2.js' type='text/javascript'></script><script type='text/javascript'>$(document).ready(function() { $('#generatedToC').toc({'selector':'h1[class!=title],h2,h3','ulClass':'menu-list'}); } );</script><div class="content is-marginless"> |
| <div class="row" data-pagefind-body="true"><div><section><p><!-- TODO reactivate TOC once JBake moves to flexmark-java --> |
| </p> |
| <h1><a href="#overview" id="overview">Overview</a></h1> |
| <p>The documentation is split into different parts:</p> |
| <ul> |
| <li><a href="/documentation/getting-started.html">Getting Started</a>, the right place to start!</li> |
| <li><a href="/documentation/the-sling-engine.html">The Sling Engine</a>, all about the heart of Sling</li> |
| <li><a href="/documentation/development.html">Development</a>, how do I get and develop with Sling</li> |
| <li><a href="/documentation/bundles.html">Bundles</a>, which bundle delivers which features to Sling</li> |
| <li><a href="/documentation/tutorials-how-tos.html">Tutorials & How-Tos</a></li> |
| <li><a href="http://cwiki.apache.org/SLING/">Wiki</a></li> |
| <li><a href="/documentation/configuration.html">Configuration</a></li> |
| <li><a href="/documentation/apidocs.html">API Documentation</a>, the javadoc of the API exposed by Sling</li> |
| </ul> |
| <h1><a href="#more-than-300-modules-no-kidding" id="more-than-300-modules-no-kidding">More than 300 modules. No kidding.</a></h1> |
| <p>As our <a href="/repolist.html">list of Git repositories</a> indicates, Sling consists of more than 300 modules.</p> |
| <p>Their importance and maturity varies, and we do our best to keep this information up to date, <a href="/documentation/development/deprecating-sling-modules.html">marking modules as deprecated</a> once they stop being useful.</p> |
| <p>Some of these modules have their documentation in their Git repositories, linked from the <a href="/repolist.html">repositories list page</a>, while others have at least part of their documentation <a href="documentation/bundles.html">on this website</a>.</p> |
| <h1><a href="#how-you-can-contribute" id="how-you-can-contribute">How you can contribute</a></h1> |
| <p>We're on the way to improve the documentation, but it's a long way. If you would like to contribute to the documentation you are very welcome. Please directly post your proposals to the <a href="http://cwiki.apache.org/SLING/">public wiki</a> or post your suggestions to the <a href="/project-information.html">mailing list</a>.</p> |
| <h1><a href="#how-the-documentation-is-generated" id="how-the-documentation-is-generated">How the documentation is generated</a></h1> |
| <p>The basic documentation of Sling is made up of four parts:</p> |
| <ol> |
| <li>The Sling Site at http://sling.apache.org/ (you are here)</li> |
| <li>The Public Wiki at http://cwiki.apache.org/SLING</li> |
| <li>The JavaDoc</li> |
| <li>The Maven plugin documentation</li> |
| </ol> |
| <p>This page is about how this documentation is maintained and who is allowed to do what.</p> |
| <h2><a href="#the-sling-website" id="the-sling-website">The Sling Website</a></h2> |
| <p>The website is built from a dedicated repository as described <a href="/project-information.html#documentation-repository">Project Information</a>.</p> |
| <h2><a href="#the-public-wiki" id="the-public-wiki">The Public Wiki</a></h2> |
| <p>The public wiki of Sling is available at <a href="http://cwiki.apache.org/SLING">http://cwiki.apache.org/SLING</a> and is maintained in the Confluence space <em>SLING</em>. Everyone can create an account there. To gain edit rights please ask via the <a href="/project-information.html">mailing list</a>. Any of the administrators listed in the <a href="https://cwiki.apache.org/confluence/spaces/viewspacesummary.action?key=SLING&showAllAdmins=true">Space Overview</a> can give you access.</p> |
| <h2><a href="#the-javadoc" id="the-javadoc">The JavaDoc</a></h2> |
| <p>With every major release of Sling the JavaDoc of all containing bundles are published below <a href="http://sling.apache.org/apidocs/">http://sling.apache.org/apidocs/</a>. The script for generating this aggregation JavaDoc is in the sling-tooling-release repo, at <a href="https://github.com/apache/sling-tooling-release/blob/master/generate_javadoc_for_release.sh">generate_javadoc_for_release.sh</a>.</p> |
| <p>In addition every released bundle is released together with its JavaDoc (which is also pushed to Maven Central).</p> |
| <h2><a href="#the-maven-plugin-documentation" id="the-maven-plugin-documentation">The Maven Plugin Documentation</a></h2> |
| <p>For the most important Maven Plugins the according Maven Sites (generated with the <code>maven-site-plugin</code>) are published at <a href="http://sling.apache.org/components/">http://sling.apache.org/components/</a>. The description on how to publish can be found at <a href="/documentation/development/release-management.html">Release Management</a>.</p> |
| </section></div></div><div data-pagefind-body="true" data-pagefind-weight="7.0" style="display:none;"> - ( Documentation )</div> |
| </div> |
| </div> |
| </div> |
| </div><footer class="footer"> |
| <div class="content has-text-centered is-small"> |
| <div class="editpagelink"> |
| This page can be edited on GitHub at <a href="https://github.com/apache/sling-site/edit/master/src/main/jbake/content/documentation.md"> |
| content/documentation.md |
| </a> |
| </div> <div class="revisionInfo"> |
| Last modified by <span class="author">Bertrand Delacretaz</span> on <span class="comment">2023-09-28</span> |
| </div><p> |
| Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project |
| logo are trademarks of The Apache Software Foundation. All other marks mentioned |
| may be trademarks or registered trademarks of their respective owners. |
| </p><p> |
| Copyright © 2007-2024<a href="https://www.apache.org/"> |
| The Apache Software Foundation |
| </a>|<a href="https://privacy.apache.org/policies/privacy-policy-public.html"> |
| Privacy Policy |
| </a> |
| </p> |
| </div> |
| </footer> |
| </div> |
| </body> |
| </html> |
