Wiki source code of Documentation for XWiki Standard & Extensions
Last modified by Vincent Massol on 2026/04/14 15:32
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | == Where to find Documentation? == | ||
| 2 | |||
| 3 | You'll find below two documentation systems: | ||
| 4 | * The current one. | ||
| 5 | * The new one, that we're currently working on and that is supposed to replace the current one in the future. | ||
| 6 | |||
| 7 | The strategy being applied for the new documentation system is the following: | ||
| 8 | * Every day, we are moving documentation pages from the old system to the new one. | ||
| 9 | * While doing so, we keep the old documentation pages and sections and provide links to the new documentation when the documentation is moved. | ||
| 10 | * New documentation pages have links to the current documentation pages when the target pages have not yet been moved. | ||
| 11 | * If you don't find what you're looking for in the new documentation, you should check in the current documentation. | ||
| 12 | |||
| 13 | Additionally, we are gathering feedback to improve the documentation experience. You can share your thoughts by filling in the [[XWiki.org Website Survey>>Survey.XWikiOrgFeedback]]. | ||
| 14 | |||
| 15 | == New Documentation (Work in Progress) == | ||
| 16 | |||
| 17 | {{velocity}} | ||
| 18 | $xwiki.ssx.use('Download.WebHome') | ||
| 19 | {{/velocity}} | ||
| 20 | |||
| 21 | (%class="download-options"%)((( | ||
| 22 | (%class="col-xs-12 download-container download-option version-option border-cyan "%)((( | ||
| 23 | === [[Documentation>>documentation.WebHome]] === | ||
| 24 | Top level documentation page for the new documentation. | ||
| 25 | (%class="version-footer"%)((( | ||
| 26 | [[Learn>>documentation.xs.WebHome||class="btn btn-info]] | ||
| 27 | ))) | ||
| 28 | ))) | ||
| 29 | (%class="col-xs-12 download-container download-option version-option border-blue "%)((( | ||
| 30 | === [[XWiki Standard>>documentation.xs.WebHome]] === | ||
| 31 | Direct access to the documentation for XWiki Standard. | ||
| 32 | (%class="version-footer"%)((( | ||
| 33 | [[Learn>>documentation.xs.WebHome||class="btn btn-info]] | ||
| 34 | ))) | ||
| 35 | ))) | ||
| 36 | (%class="col-xs-12 download-container download-option version-option border-green "%)((( | ||
| 37 | === [[Extensions>>documentation.extensions.WebHome]] === | ||
| 38 | Direct access to the documentation for XWiki Extensions. | ||
| 39 | (%class="version-footer"%)((( | ||
| 40 | [[Learn>>documentation.extensions.WebHome||class="btn btn-info]] | ||
| 41 | ))) | ||
| 42 | ))) | ||
| 43 | ))) | ||
| 44 | |||
| 45 | == Current Documentation == | ||
| 46 | |||
| 47 | (%class="download-options"%)((( | ||
| 48 | (%class="col-xs-12 download-container download-option version-option border-cyan fa-icon fa-user"%)((( | ||
| 49 | === [[User Guide>>xwiki:Documentation.UserGuide.WebHome]] === | ||
| 50 | Dedicated for standard users of the wiki. It contains a Getting Started Guide and a reference to the [[Features>>xwiki:Documentation.UserGuide.Features.WebHome]], in addition to videos and tutorials. | ||
| 51 | (%class="version-footer"%)((( | ||
| 52 | [[Learn>>Documentation.UserGuide.WebHome||class="btn btn-info]] | ||
| 53 | ))) | ||
| 54 | ))) | ||
| 55 | (%class="col-xs-12 download-container download-option version-option border-blue fa-icon fa-cogs"%)((( | ||
| 56 | === [[Admin Guide>>xwiki:Documentation.AdminGuide.WebHome]] === | ||
| 57 | Provides general information for administrators that need to customize and administer their XWiki installation (authentication, DB, performance tuning, etc.) | ||
| 58 | (%class="version-footer"%)((( | ||
| 59 | [[Administer>>Documentation.AdminGuide.WebHome||class="btn btn-primary]] | ||
| 60 | ))) | ||
| 61 | ))) | ||
| 62 | (%class="col-xs-12 download-container download-option version-option border-green fa-icon fa-code"%)((( | ||
| 63 | === [[Developer Guide>>xwiki:Documentation.DevGuide.WebHome]] === | ||
| 64 | Details how to develop in-wiki applications or how to integrate other software with XWiki. Contains details on how to insert scripts into XWiki pages. | ||
| 65 | (%class="version-footer"%)((( | ||
| 66 | [[Develop>>Documentation.DevGuide.WebHome||class="btn btn-success]] | ||
| 67 | ))) | ||
| 68 | ))) | ||
| 69 | ))) | ||
| 70 | |||
| 71 | (%class="noitems"%)If you need more help with your wiki or you'd like to get in touch with the community please visit the [[Support>>xwiki:Main.Support]] for more information. | ||
| 72 | |||
| 73 | === FAQ === | ||
| 74 | |||
| 75 | If you still have a question after reading these guides, check our [[FAQ>>xwiki:FAQ.WebHome]], which provides answers to common questions, for users, developers and administrators. | ||
| 76 | |||
| 77 | === Projects and Extensions === | ||
| 78 | |||
| 79 | The XWiki.org web site is organized by [[projects and extensions>>xwiki:Main.Forge]], each having their own site. Every site holds the documentation for its projects: | ||
| 80 | * [[Documentation for Extensions>>extensions:Main.WebHome]] | ||
| 81 | * [[Documentation for Snippets>>snippets:Main.WebHome]] | ||
| 82 | * [[Documentation for XWiki Rendering>>rendering:Main.WebHome]] | ||
| 83 | * [[Documentation for XWiki Commons>>commons:Main.WebHome]] | ||
| 84 | |||
| 85 | You can also check [[external articles and documentation about XWiki>>Main.ExternalLinks]]. | ||
| 86 | |||
| 87 | Information regarding the Open Source development of the XWiki Platform itself or to XWiki related projects and extensions can be found on the [[Development>>dev:Main.WebHome]] wiki and on the [[Contrib>>contrib:Main.WebHome]] wiki. |
