Wiki source code of XWiki
Version 24.1 by Boris Folgmann on 2025/06/27 12:50
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 | {{toc/}} | ||
| 5 | |||
| 6 | = Introduction = | ||
| 7 | |||
| 8 | 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. | ||
| 9 | |||
| 10 | [[Vendor Page>>https://www.xwiki.org/xwiki/bin/view/Main/WebHome]] | ||
| 11 | |||
| 12 | There are several useful resources available to get started with XWiki: | ||
| 13 | |||
| 14 | [[XWiki Documentation>>https://www.xwiki.org/xwiki/bin/view/Documentation/]] | ||
| 15 | |||
| 16 | [[XWikiTutorials>>https://www.xwiki.org/xwiki/bin/view/Documentation/UserGuide/GettingStarted/]] | ||
| 17 | |||
| 18 | = Accessing XWiki = | ||
| 19 | |||
| 20 | == Preconditions in DevOps portal to access XWiki == | ||
| 21 | |||
| 22 | 1. A XWiki license must be assigned to the user | ||
| 23 | 1. XWiki must be added to the tool list of the project | ||
| 24 | 1. If you are not already logged in to another tool in the toolchain or the DevOps portal, then you have to login using your configured SSO credentials. | ||
| 25 | |||
| 26 | 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. | ||
| 27 | |||
| 28 | == Via DevOps Portal == | ||
| 29 | |||
| 30 | Go to the DevOps Portal Homepage and click on the link //Project Wiki// in the XWiki tile: | ||
| 31 | |||
| 32 | [[image:Untitled.png||alt="XWiki-Tile" data-xwiki-image-style-border="true"]] | ||
| 33 | |||
| 34 | == Via Direct URL == | ||
| 35 | |||
| 36 | You can also access XWiki directly using the following link format: | ||
| 37 | [[https:~~/~~/<customer~>.devops.t-systems.net/xwiki/wiki/<pkey~>/view>>https://<customer>.devops.t-systems.net/xwiki/wiki/<pkey>/view]] where <customer> is the id of your DevOps-as-a-Service instance and <pkey> is the project key in lowercase letters. | ||
| 38 | |||
| 39 | (% class="box warningmessage" %) | ||
| 40 | ((( | ||
| 41 | ⚠ **Note** | ||
| 42 | 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 therefore this page cannot be viewed. | ||
| 43 | ))) | ||
| 44 | |||
| 45 | (% class="box warningmessage" %) | ||
| 46 | ((( | ||
| 47 | ⚠ **Note** | ||
| 48 | If you are still unable to access your project in XWiki, it may be because you are logged in with an old session that still uses outdated permissions. To resolve this issue, please log out and then log in again: | ||
| 49 | \\[[image:Untitled2.png||height="185" width="825"]] | ||
| 50 | |||
| 51 | ))) | ||
| 52 | |||
| 53 | = Users, Projects and Roles = | ||
| 54 | |||
| 55 | * Projects, users and their roles in projects are managed in the DevOps Portal, the corresponding functions in XWiki are disabled (UI and API) | ||
| 56 | |||
| 57 | (% class="box warningmessage" %) | ||
| 58 | ((( | ||
| 59 | ⚠ **Note** | ||
| 60 | Projects in the DevOps portal are mapped to corresponding subwikis in XWiki | ||
| 61 | ))) | ||
| 62 | |||
| 63 | * When XWiki is added as a tool to an existing or new project, a corresponding subwiki is automatically created. Users assigned to the project in the DevOps Portal are then added to the subwiki with the roles defined in the configuration : | ||
| 64 | ** Role mapping: ((( | ||
| 65 | (% class="active" %)|=(% style="width: 237px;" %)Project Role in DevOps Portal|=(% style="width: 704px;" %)Permissions in XWiki | ||
| 66 | |(% style="width:237px" %)Admin|(% style="width:704px" %)View, comment, edit, and delete pages | ||
| 67 | |(% style="width:237px" %)Master|(% colspan="1" style="width:704px" %)Can view, comment, and edit pages, but cannot delete content | ||
| 68 | |(% style="width:237px" %)Developer|(% colspan="1" style="width:704px" %)Similar to Master | ||
| 69 | |(% style="width:237px" %)Viewer|(% style="width:704px" %)Read-only access. Can only view content, no edits or comments allowed | ||
| 70 | |||
| 71 | 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/]] | ||
| 72 | ))) | ||
| 73 | |||
| 74 | = Main Features = | ||
| 75 | |||
| 76 | Inside DevOps-as-a-Service, XWiki is mainly used for writing specifications and documentations. See below for a list of the main features of XWiki. | ||
| 77 | |||
| 78 | == Collaborative Content Editing == | ||
| 79 | |||
| 80 | * WYSIWYG and wiki syntax editors | ||
| 81 | * Version control and history tracking | ||
| 82 | * Inline and structured content editing | ||
| 83 | * Commenting and annotations | ||
| 84 | |||
| 85 | == Advanced Page & Document Management == | ||
| 86 | |||
| 87 | * Hierarchical page structure (nested pages) | ||
| 88 | * Templates for creating structured documents | ||
| 89 | * Tags, categories, and metadata support | ||
| 90 | * File attachments and preview | ||
| 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 | == Macros and Widgets == | ||
| 99 | |||
| 100 | * Built-in and custom macros (charts, galleries, diagrams) | ||
| 101 | * Embedding of rich media (videos, iframes, etc.) | ||
| 102 | * Markdown and LaTeX support | ||
| 103 | |||
| 104 |