blob: b6d505a549fd29ee45c81c14970af65f69052a5e [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta charset="utf-8">
<title>Documentation | Apache Wicket</title>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="shortcut icon" href="/favicon.ico" type="image/vnd.microsoft.icon" />
<link rel="stylesheet" href="/css/style.css" type="text/css" media="screen" />
<link href="//maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" />
<script src="//code.jquery.com/jquery-1.11.3.min.js"></script>
</head>
<body class="">
<div class="header default">
<div class="l-container">
<nav class="mainmenu">
<div class="nav-logo">
<a href="/"><img src="/img/logo-apachewicket.svg" alt="Apache Wicket"></a>
</div>
<div class="nav-container">
<!-- /start/quickstart.html || /learn/ -->
<a href="/start/quickstart.html" class=" nav-items">Quick Start</a>
<!-- /start/download.html || /learn/ -->
<a href="/start/download.html" class=" nav-items">Download</a>
<!-- /learn || /learn/ -->
<a href="/learn" class=" nav-items">Documentation</a>
<!-- /help || /learn/ -->
<a href="/help" class=" nav-items">Support</a>
<!-- /contribute || /learn/ -->
<a href="/contribute" class=" nav-items">Contribute</a>
<!-- /community || /learn/ -->
<a href="/community" class=" nav-items">Community</a>
<!-- /apache || /learn/ -->
<a href="/apache" class=" nav-items">Apache</a>
</div>
<div class="nav-container ">
<a href="https://github.com/apache/wicket" target="_blank"><i class="fa fa-github nav-items"></i></a>
<a href="https://twitter.com/apache_wicket" target="_blank"><i class="fa fa-twitter nav-items"></i></a>
<a href="https://builtwithwicket.tumblr.com" target="_blank"><i class="fa fa-tumblr nav-items"></i></a>
</div>
</nav>
</div>
</div>
<main>
<div class="l-container">
<header class="l-full preamble">
<h1>Documentation</h1>
<h2>All the things you want to know about Wicket but are afraid to ask</h2>
<p>No matter how you want to learn about Wicket, there's something available for you. If you want a quick reference, use the User Guide. If you rather prefer a book, there's a couple waiting for you. And if you rather watch a video or presentation, we have that covered too.</p>
</header>
<section class="toc left">
<div id="toc" class="toc"><div id="toc-title"><h2>Table of Contents</h2></div><ul><li class="toc--level-1 toc--section-1"><a href="#news"><span class="toc-number">1</span> <span class="toc-text">News Archive</span></a></li><li class="toc--level-1 toc--section-2"><a href="#guide"><span class="toc-number">2</span> <span class="toc-text">Wicket User Guide</span></a></li><li class="toc--level-1 toc--section-3"><a href="#javadoc"><span class="toc-number">3</span> <span class="toc-text">API Documentation</span></a></li><li class="toc--level-1 toc--section-4"><a href="#migrations"><span class="toc-number">4</span> <span class="toc-text">Migration Guides</span></a></li><li class="toc--level-1 toc--section-5"><a href="#support"><span class="toc-number">5</span> <span class="toc-text">Getting help</span></a></li><li class="toc--level-1 toc--section-6"><a href="#ides"><span class="toc-number">6</span> <span class="toc-text">IDE Support</span></a></li><li class="toc--level-1 toc--section-7"><a href="#examples"><span class="toc-number">7</span> <span class="toc-text">Examples</span></a></li><li class="toc--level-1 toc--section-8"><a href="#courses"><span class="toc-number">8</span> <span class="toc-text">Online courses</span></a></li><li class="toc--level-1 toc--section-9"><a href="#presentations"><span class="toc-number">9</span> <span class="toc-text">Presentations</span></a></li></ul></div>
</section>
<section>
<div class="l-button-table">
<div class="l-two-third">
<div class="button-bar">
<a class="button" href="#news"><i class="fa fa-newspaper-o"></i><br />News</a>
<a class="button" href="blogs.html"><i class="fa fa-rss"></i><br />Blogs</a>
<a class="button" href="https://cwiki.apache.org/WICKET"><i class="fa fa-users"></i><br />Wiki</a>
</div>
<div class="button-bar">
<a class="button" href="#guide"><i class="fa fa-file-text-o"></i><br />User Guide</a>
<a class="button" href="#javadoc"><i class="fa fa-code"></i><br />API docs</a>
<a class="button" href="books/index.html"><i class="fa fa-book"></i><br />Books</a>
</div>
<div class="button-bar">
<a class="button" href="#migrations"><i class="fa fa-history"></i><br />Migrations</a>
<a class="button" href="#presentations"><i class="fa fa-file-powerpoint-o"></i><br />Presentations</a>
<a class="button" href="#ides"><i class="fa fa-terminal"></i><br />IDEs</a>
</div>
<div class="button-bar">
<a class="button" href="#courses"><i class="fa fa-graduation-cap"></i><br />Online courses</a>
<div class="button"></div>
<a class="button" href="#examples"><i class="fa fa-life-ring"></i><br />Support &amp; Examples</a>
</div>
</div>
</div>
<h2 id="news">News Archive</h2>
<p>Every release is announced through our mailing lists and the official Apache announcements list.
We also publish a news item on our website with the announcement, and it is also published in our <a type="application/atom+xml" title="Atom 1.0 feed" href="/atom.xml">RSS feed</a> (handy for RSS readers).</p>
<p>Here are the most recent headlines:</p>
<ul>
<li>
<p><a href="/news/2020/07/15/wicket-9-released.html">Announcing Apache Wicket 9: get into the modern Java world!</a> <small>15 Jul 2020</small></p>
</li>
<li>
<p><a href="/news/2020/04/24/wicket-8.8.0-released.html">Apache Wicket 8.8.0 released</a> <small>24 Apr 2020</small></p>
</li>
<li>
<p><a href="/news/2020/04/06/wicket-9.0.0-M5-released.html">Apache Wicket 9.0.0-M5 released</a> <small>06 Apr 2020</small></p>
</li>
</ul>
<p>The complete articles and all other news items are available in the <a href="/news">archives</a>.</p>
<hr />
<h2 id="guide">Wicket User Guide</h2>
<p>Learn building web applications with Wicket from scratch reading its
200+ page user guide. The guide gradually introduces you to the various
features of the framework with many real-world examples. It covers
subjects such as models, behaviours, testing and integration with other
projects.</p>
<p>The guide is available as PDF or html file for the following versions:</p>
<ol>
<li>Wicket 9.x
<ul>
<li><a href="https://ci.apache.org/projects/wicket/guide/9.x/single.html">HTML (single page)</a></li>
<li><a href="https://ci.apache.org/projects/wicket/guide/9.x/single.pdf">PDF</a></li>
</ul>
</li>
<li>Wicket 8.x
<ul>
<li><a href="https://ci.apache.org/projects/wicket/guide/8.x/single.html">HTML (single page)</a></li>
<li><a href="https://ci.apache.org/projects/wicket/guide/8.x/single.pdf">PDF</a></li>
</ul>
</li>
<li>Wicket 7.x
<ul>
<li><a href="http://ci.apache.org/projects/wicket/guide/7.x/single.html">HTML (single page)</a></li>
<li><a href="http://ci.apache.org/projects/wicket/guide/7.x/single.pdf">PDF</a></li>
</ul>
</li>
<li>Wicket 6.x
<ul>
<li><a href="http://ci.apache.org/projects/wicket/guide/6.x/">HTML</a></li>
<li><a href="http://ci.apache.org/projects/wicket/guide/6.x/guide/single.html">HTML (single page)</a></li>
<li><a href="http://ci.apache.org/projects/wicket/guide/6.x/guide/single.pdf">PDF</a></li>
</ul>
</li>
</ol>
<p>You can use the guide for older releases even though there will be
differences. We urge you however to upgrade your project to the latest
stable release rather than sticking on an older version.</p>
<hr />
<h2 id="javadoc">API Documentation</h2>
<p>Each release of Wicket comes with sources, including JavaDocs. When you
use Maven for dependency management, your IDE will automatically
download the source JARs and when you hover on a Wicket class or
method, show you the corresponding documentation.</p>
<p>For reference we also publish the API documentation online so you can
link to it from emails or websites:</p>
<ul>
<li><a href="https://ci.apache.org/projects/wicket/apidocs/9.x/index.html">JavaDoc 9.x</a></li>
<li><a href="http://ci.apache.org/projects/wicket/apidocs/8.x/index.html">JavaDoc 8.x</a></li>
<li><a href="http://ci.apache.org/projects/wicket/apidocs/7.x/index.html">JavaDoc 7.x</a></li>
<li><a href="http://ci.apache.org/projects/wicket/apidocs/6.x/index.html">JavaDoc 6.x</a></li>
<li><a href="http://ci.apache.org/projects/wicket/apidocs/1.5.x/index.html">JavaDoc 1.5.x</a></li>
<li><a href="http://ci.apache.org/projects/wicket/apidocs/1.4.x/index.html">JavaDoc 1.4.x</a></li>
<li><a href="http://ci.apache.org/projects/wicket/apidocs/1.3.x/index.html">JavaDoc 1.3.x</a></li>
</ul>
<hr />
<h2 id="migrations">Migration Guides</h2>
<p>When you upgrade your application from an older Wicket version to a
newer version you can run into all of the changes that were applied to
Wicket’s API. We have done our best to document all the changes and
provide migration paths between the different Wicket versions.</p>
<p>Here’s a list of the migration guides:</p>
<div class="l-button-table">
<div class="l-two-third">
<div class="button-bar">
<a class="button" href="http://s.apache.org/wicket9migration">
Wicket 9<br />
migration guide
</a>
<a class="button" href="http://s.apache.org/wicket8migration">
Wicket 8<br />
migration guide
</a>
<a class="button" href="http://s.apache.org/wicket7migrate">
Wicket 7<br />
migration guide
</a>
</div>
<div class="button-bar">
<a class="button" href="http://s.apache.org/wicket6migration">
Wicket 6<br />
migration guide
</a>
<a class="button" href="http://s.apache.org/wicket5migrate">
Wicket 1.5<br />
migration guide
</a>
<a class="button" href="http://s.apache.org/wicket4migrate">
Wicket 1.4<br />
migration guide
</a>
</div>
<div class="button-bar">
<a class="button" style="visibility: hidden;"></a>
<a class="button" href="http://s.apache.org/wicket3migrate">
Wicket 1.3<br />
migration guide
</a>
<a class="button" style="visibility: hidden;"></a>
</div>
</div>
</div>
<p>If you encounter a change that was not in the migration guide, don’t
hesitate to notify us.</p>
<hr />
<h2 id="support">Getting help</h2>
<p>Stuck with a problem? See how you can find <a href="/help/index.html">support</a>!</p>
<hr />
<h2 id="ides">IDE Support</h2>
<p>Wicket is well supported by the three main Java IDEs (NetBeans, IntelliJ and Eclipse).
Find <a href="/contribute/ides.html">here</a> how to work with Wicket projects with your favourite IDE.</p>
<hr />
<h2 id="examples">Examples</h2>
<ul>
<li><a href="/learn/examples/index.html">Examples</a> - Browse a vast collection of examples in live action without having to install anything!</li>
</ul>
<hr />
<h2 id="courses">Online courses</h2>
<ul>
<li><a href="https://www.udemy.com/course/apache-wicket-kompakt/">Apache Wicket Kompakt</a> - A complete German-based course with many pratical examples.</li>
</ul>
<hr />
<h2 id="presentations">Presentations</h2>
<p>New to Wicket and eager to learn it? This <a href="/learn/presentations/wicketIntroduction.pdf">presentation</a> is for you!</p>
</section>
</div>
</main>
<footer>
<div class="l-container">
<div class="left">
<img src="/img/asf_logo_url.svg" style="height:90px; float:left; margin-right:10px;">
<div style="margin-top:12px;">Copyright © 2020 — The Apache Software Foundation. Apache Wicket, Wicket, Apache, the Apache feather logo, and the Apache Wicket project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</div>
</div>
</div>
</footer>
</body>
</html>