| --- |
| layout: post |
| status: PUBLISHED |
| published: true |
| title: 'JSPWiki feature highlight: Tab Completion' |
| id: 39ef6f95-4bfe-48ad-8dad-c57d0db148fd |
| date: '2016-08-02 12:40:38 -0400' |
| categories: jspwiki |
| tags: |
| - haddock |
| - editor |
| permalink: jspwiki/entry/jspwiki_feature_highlight_tab_completion |
| --- |
| <p>Continuing on from yesterday's blog post on <a title="Link to the Smart Typing Pairs blog post" href="https://blogs.apache.org/jspwiki/entry/haddock_editor_feature_smart_typing" target="_blank">Smart Typing Pairs</a>, let's look at another time-saving feature in JSPWiki's <a title="Link to information on the Haddock editor" href="https://jspwiki-wiki.apache.org/Wiki.jsp?page=Haddock%20Editor" target="_blank">Haddock plain editor</a>: <em>Tab Completion</em>.</p></p> |
| <p>When Tab Completion is enabled, certain keywords typed into the editor will expand into JSPWiki markup when followed by a Tab keystroke.</p> |
| <p>Enable Tab Completion in the Haddock editor's settings menu:</p> |
| <p><img src="https://blogs.apache.org/jspwiki/mediaresource/3d388d21-113e-4b4f-8816-0e8077555ce1" alt="Enabling JSPWiki Tab Completion" /></p> |
| <p>A good example demonstrating the use of Tab Completion is adding a table of contents. Without Tab Completion, adding a table of contents is achieved by manually entering the following markup:</p> |
| <pre>[{TableOfContents}]
|
| </pre> |
| <p>To add a table of contents using Tab Completion, enter the keyword <em>toc</em> followed by a Tab keystroke. JSPWiki automatically expands the keyword into the full markup.</p> |
| <p>Other Tab Completion examples include the <em>sign</em> keyword (which inserts a user's signature and date), and the <em>quote</em> keyword (which creates fancy formatting for quoted content).</p> |
| <p>The full set of available keywords is listed <a href="https://jspwiki-wiki.apache.org/Wiki.jsp?page=Haddock%20Editor#section-Haddock+Editor-Snippets" title="List of Haddock editor snippets for tab completion" target="_blank">here</a>, and you can also add your own custom keywords.</p> |
| <p></p> |
