Wiki source code of XWiki
Version 6.1 by Milad Afshar-Jahanshahi on 2025/06/26 08:43
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="wikigeneratedid" %) | ||
| 2 | [[image:XWiki-logo-color.png||alt="Grafana Icon Logo PNG vector in SVG, PDF, AI, CDR format" data-xwiki-image-style-alignment="end" height="52" width="190"]] | ||
| 3 | |||
| 4 | = Content = | ||
| 5 | |||
| 6 | {{toc/}} | ||
| 7 | |||
| 8 | = Introduction = | ||
| 9 | |||
| 10 | XWiki is an open-source platform for creating, managing, and collaborating on structured and unstructured content. It functions as a powerful wiki engine with advanced features like version control, rights management, scripting, and extensible applications. XWiki enables users to build knowledge bases, documentation platforms, or collaborative intranets, all within a customizable and web-based environment. | ||
| 11 | |||
| 12 | [[Vendor Page>>https://www.xwiki.org/xwiki/bin/view/Main/WebHome]] | ||
| 13 | |||
| 14 | There is good documentation to start using XWiki: | ||
| 15 | |||
| 16 | [[XWiki Documentation>>https://www.xwiki.org/xwiki/bin/view/Documentation/]] | ||
| 17 | |||
| 18 | [[XWikiTutorials>>https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/GettingStarted/]] | ||
| 19 | |||
| 20 | = Accessing XWiki = | ||
| 21 | |||
| 22 | == Preconditions in DevOps portal to access XWiki == | ||
| 23 | |||
| 24 | * A XWiki license must be assigned to the user | ||
| 25 | * XWiki must be added to the tool list of the project | ||
| 26 | * If you are not already logged in to another tool in the toolchain, then you have to login using your configured SSO credentials. | ||
| 27 | * When you see this message after entering your credentials, then you don't have a XWiki license assigned in the DevOps portal: | ||
| 28 | [[image:1744266590219-161.png||height="242" width="293"]] | ||
| 29 | |||
| 30 | After completing the preconditions, a project in XWik, which is part of the DevOps-as-a-Service toolchain, can be accessed via the DevOps Portal or directly through a URL. | ||
| 31 | |||
| 32 | == Via DevOps Portal == | ||
| 33 | |||
| 34 | Go to the DevOps Portal Homepage and click on the XWiki tile: | ||
| 35 | |||
| 36 | [[image:Untitled.png||alt="XWiki-Tile" data-xwiki-image-style-border="true"]] | ||
| 37 | |||
| 38 | == Via Direct URL == | ||
| 39 | |||
| 40 | You can also access it directly using the following link format: | ||
| 41 | [[https:~~/~~/<customer~>.devops.t-systems.net/xwiki/wiki/<MyProject~>/view>>https://<customer>.devops.t-systems.net/xwiki/wiki/<MyProject>/view]] | ||
| 42 | |||
| 43 | (% class="box warningmessage" %) | ||
| 44 | ((( | ||
| 45 | ⚠ **Note** | ||
| 46 | Access to the main wiki at [[https:~~/~~/<customer~>.devops.t-systems.net/xwik>>https://<customer>.devops.t-systems.net/xwik]] is forbidden due to security restrictions and this page cannot be viewed. | ||
| 47 | ))) | ||
| 48 | |||
| 49 | |||
| 50 | |||
| 51 | = Users, Projects and Roles = | ||
| 52 | |||
| 53 | * Projects, users and their roles in projects are managed in the DevOps portal, the corresponding functions in XWiki are disabled (UI and API) | ||
| 54 | |||
| 55 | (% class="box warningmessage" %) | ||
| 56 | ((( | ||
| 57 | ⚠ **Note** | ||
| 58 | Projects in the DevOps portal are mapped to corresponding subwikis in XWiki | ||
| 59 | ))) | ||
| 60 | |||
| 61 | * When a new project is created in the portal with XWiki configured as a tool, a corresponding subwiki is automatically created. Users assigned to the project in the portal are then added to the subwiki with the roles defined in the configuration : | ||
| 62 | ** Role mapping: ((( | ||
| 63 | (% class="active" %)|=(% style="width: 237px;" %)Project Role in DevOps Portal|=(% style="width: 899px;" %)Permissions in XWiki | ||
| 64 | |(% style="width:237px" %)Admin|(% style="width:899px" %)View, comment, edit, and delete pages | ||
| 65 | |(% style="width:237px" %)Master|(% colspan="1" style="width:899px" %)Can view, comment, and edit pages, but cannot delete content | ||
| 66 | |(% style="width:237px" %)Developer|(% colspan="1" style="width:899px" %)Similar to Master | ||
| 67 | |(% style="width:237px" %)Viewer|(% style="width:899px" %)Read-only access. Can only view content, no edits or comments allowed | ||
| 68 | |||
| 69 | A detailed description of the XWiki role model can be found [[here>>https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Access%20Rights/Permission%20types/]] | ||
| 70 | ))) | ||
| 71 | |||
| 72 | = Main Functions = | ||
| 73 | |||
| 74 | == Collaborative Content Editing == | ||
| 75 | |||
| 76 | * WYSIWYG and wiki syntax editors | ||
| 77 | * Version control and history tracking | ||
| 78 | * Inline and structured content editing | ||
| 79 | * Commenting and annotations | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | == Advanced Page & Document Management == | ||
| 84 | |||
| 85 | * Hierarchical page structure (nested pages) | ||
| 86 | * Templates for creating structured documents | ||
| 87 | * Tags, categories, and metadata support | ||
| 88 | * File attachments and preview | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | == Powerful Search and Navigation == | ||
| 93 | |||
| 94 | * Full-text search (Solr-based) | ||
| 95 | * Faceted search filters | ||
| 96 | * Page index, breadcrumbs, and navigation panels | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | == Macros and Widgets == | ||
| 101 | |||
| 102 | * Built-in and custom macros (charts, galleries, diagrams) | ||
| 103 | * Embedding of rich media (videos, iframes, etc.) | ||
| 104 | * Markdown and LaTeX support | ||
| 105 | |||
| 106 |