Various tools to help write Documentation for a software product using XWiki

Description

To get started check the Documentation Application.

Entry Points

The top module, which you should install if you want to install all features is the Documentation Application one.

And install the XWiki.org documentation checks to have your XWiki instance validate documentation pages with them.

Extensions

This project contains the following Extensions.

Versions

1.13.2

• Bug #113 Some value of ConfluenceMacroDocumentationClassSheet are not escaped
• Improvement #115Confluence macro doc - Show "xwikiPage" link if "equivXWikiFeature" is not set

1.13.1

• Bug #10315 FAQ lines is too small
• Bug #104Last space reference name should be checked instead of WebHome for non-terminal pages

1.13

• Improvement #64Add check for referenced images to be using the agreed kebab case
• Improvement #65Add Check for attachments with video specific file extensions
• Improvement #66Add Check for usage of Video Macro with attachments
• Improvement #67Add Checks for "reserved" words in page titles and names + that titles are not empty
• Improvement #96Add check to verify page names
• Improvement #97Also perform image checks when the images are located inside a macro containing wiki markup
• Improvement #98Also perform Image checks for images located inside the "FAQ" section
• Improvement #99Add checks to count the FAQ entries
• Improvement #101Prevent doc pages from not having a type set
• Improvement #102Check that howto/tutorial start with a verb and explanation/reference do not
• New Feature #45Provide a Deprecated Macro
• New Feature #56Display last reviewed dates and reviewers in the documentation extradoc tab
• New Feature #83Add an Image macro for consistent styling

1.12.1

• Bug #91: Confluence documentation - document content are not shown in Additional information section
• Bug #94: confluenceMacroDocumentationList macro fix reference handling
• Bug #95: Title of confluence macro doc and confluence plugin doc should not put WebHome by default
• Improvement #92: Confluence documentation - document content are not shown in Additional information section
• Improvement #93: confluenceMacroDocumentationList macro fix reference handling

1.12

• Improvement #72: Imrove description for confluence plugin documentation field pluginName
• Improvement #73: Confluence macro doc - Improve sheet
• New Feature #74: Confluence macro doc - Add template
• New Feature #75: Add a macro to list the confluence macro documentation
• Improvement #77: Split the importSupportQualifier and the requiredForUsage fields in the Confluence macro documentation
• Improvement #78: Refine handling types in the Confluence macro documentation
• Bug #86: The Confluence Macro Documentation Sheet uses a code macro with an empty language parameter
• Bug #89: The Confluence Macro Documentation Sheet uses a code macro with an empty language parameter
• Bug #90: When a required usage extension name is given, no link to the extension page is produced

1.11.1

• Bug #70: There is an extra space in the leading sentence of the Confluence macro documentation
• Bug #71: Links in the leading sentence in the Confluence macro documentation always display content

1.11

• Bug #68: The type badges are not clickable
• Improvement #63: Add possibility to filter by type the pages displayed in the LiveData on documentation pages
• New Feature #69: Add classes and sheet for Confluence macro and plugin documentation

1.10

• Bug #60: Remove "WithTip" class usage in DocumentationSheet
• Bug #61: Don't display the More LD when it only contains the current page
• Bug #62: The version macro is styled incorrectly when used on a different wiki than where it's installed
• Improvement #50: Add checks for "alt" texts for images in Gallery macro

1.9

• Bug #52: Searching inside the search page results is broken
• Bug #57: Too much vertical space between Highlights and the More livedata
• Bug #58: Adding an Object of type LandingPage or of type DocumentationClass makes the title not editable with the In-place WYSIWYG Editor or the Inline Form Editor
• Bug #59: Remove withTip usage
• Improvement #53: Add ability to provide highlights for any documentation page
• Improvement #54: Add ability to search nested documentation pages for all documentation pages

1.8

• Improvement #51: Add a "Usage "section when display rendering macro documentation
• New Feature #49: Add a Documentation class for UIXP + add a UIX

1.7

• Improvement #46: Support multiple doc id references and add support for NPM packages
• New Feature #43: Add an UIXP to be able to customize how the main documentation content is displayed
• New Feature #44: Provide a Version Macro
• New Feature #48: Add a Documentation class for rendering macros + add a UIX
• Task #47: Rename the "org.xwiki.contrib.documentation.sheet" UIXP to "org.xwiki.contrib.documentation.sheet.top"

1.6.1

A Security issue was fixed.

1.6

1.5.1

1.5

1.4

1.3

1.2

1.1

1.0