Skip to Content

Wiki source code of Most Important Configurations

Version 3.7 by chrisby on 2023/11/18 14:53
Hide last authors
chrisby 1.5 1 Here is a summary of the steps I took to configure this XWiki website via GUI. The configurations required for your XWiki website may vary depending on your needs. Being logged in as the admin user, the **Administration** page can be found here: Triple bar icon (upper right corner) > Administer Wiki. Here you can find the different options like **Look & Feel** or **Extensions**.
chrisby 1.1 2
chrisby 3.1 3 ### Measures
chrisby 1.1 4
chrisby 3.5 5 **Delete non-required extensions**
chrisby 3.4 6
chrisby 3.5 7 * Extensions > Extensions > In the selection menu, select "Installed Extensions" > Search for "Tour Application", "Help Application" and "Sandbox Application" and uninstall them
8
9 **Upload Logo** (displayed in the upper left corner of the website)
10
11 * Look & Feel > Themes > Color Theme > COLOR THEME > Customize > Logos > Choose an attachment > Browse > Upload and select > Safe & View
12
13 **Add a tab bar below the website header**
14
15 * Look & Feel > Menus > Add new entry > (create a menu, for example "Header Menu")
16 * Add links to each bullet point so that users who click on the tab are directed to the appropriate page.
17 * At the bottom of the Menu page: Menu Display Location = After the page header; Menu Visibility Scope = Global.
18
19 **Adapt navigation panel items to your needs** (the boxes at the edges like "Navigation" or "Recently Created")
20
21 * Look & Feel > Panels > Panel List
22
23 **Change browser tab title**
24
25 * Look & Feel > Presentation > Header > Title > Remove the " - XWiki"
26 * Change favicon: Look & Feel > Themes > Skin > Customize > Edit > Logo > Choose Attachment > Browse > Select the image you want to have as a favicon. Make sure that the name of the image matches the names mentioned in the [documentation](http://sandbox.xwiki.org/xwiki/bin/view/FAQ/How+do+I+add+a+favicon+for+my+wiki). For example, svg files must be named "icons.xwiki.favicon.svg". > Upload and select image > Save & View
27
28 **Enable justification in editor**
29
30 * Editing > WYSIWYG Editor >
31 * Default WYSIWYG Editor > CKEditor > Save (Note: There are two "Save" buttons on this page.)
32 * CKEditor > Disables Plugins > Open selection of disabled plugins > uncheck "justify" plugin > click on "Save" button **below**
33
34 **Disable registration of new accounts**
35
36 * Users & Rights > Rights > XWikiAdminGroup > Add a check at "Register". Implicitly all other groups (including unregistered users) lose their right to register new accounts. See the [docs](https://www.xwiki.org/xwiki/bin/view/Documentation/AdminGuide/Access%20Rights/) for further details.
37
38 **Allow comments feature for unregistered users**
39
40 * Users & Rights > Rights > Remove the "Comment" check for each group. This implicitly allows all groups (including unregistered users) to use the comments feature.
41
42 **Set up mailing**
43
44 * Mail > Mail Sending > Email address to send from > (enter the necessary fields to enable XWiki's mailing functionality)
45 * Users & Rights > Registration > User Email verification > Yes
46
47 **Adapt the timezone**
48
49 * Content > Localization > Date/Time > Timezone
50
51 **Use Markdown as page editing syntax**
52
53 * Extensions > Extensions > Install CommonMark Markdown Syntax 1.2.
54 * Edit > Syntax > Disabled syntaxes
55 * Enable "CommonMark Markdown 1.2
56 * Uncheck "XWiki 2.1
57 * Saving
58 * Newly created articles automatically use Markdown syntax by default. When editing, simply click the "Source" button to open the Markdown source editor.
59 * Old articles will still use the previous default syntax, such as "XWiki 2.1" syntax. However, you can migrate old pages from the old syntax to the new syntax:
60 * Go to the page to edit > Information > SYNTAX > click the "Edit" icon > select "CommonMark Markdown 1.2". > A "Syntax Conversion" popup appears - click "Yes" > click the "Confirm" icon. You should now be able to edit the page in Markdown.
61 * Sometimes manual adjustments are required after conversion, as it does not always work as desired.
62
63 **Adapt the footer** - Hide XWiki version and add copyright information.
64
65 * Look & Feel > Presentation > Footer > Here you can find the fields "Copyright" and "Version".
66 * Since an empty "Version" field results in the current XWiki version being displayed, I left the "Copyright" field empty and entered the license in the "Version" field. Here are two examples when using Markdown syntax as described above:
67
chrisby 3.4 68 ```
69 The contents of this website are available under the [CC0 1.0 Universal license](https://creativecommons.org/publicdomain/zero/1.0/deed.en); additional terms may apply.
70 The contents of this website are available under the [Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/); additional terms may apply.
71 ```
chrisby 3.6 72
chrisby 3.7 73 **Dark Theme**
chrisby 3.6 74
75 * Look & Feel > Themes > Color Theme > COLOR_THEMES
76 * Manage Color Themes > "Darkly" Theme > Use this theme
77 * Customize > Advanced > Add the following code at the end and then "Save & View":
78
79 ```CSS
80 // Own customizations
81 #var-lessCode,
82 .macro-parameter-field textarea,
83 .code span,
84 .xwikipaneltitle {
85 color: #ffffff !important;
86 }
87
88 h1, h2, h3, h4, h5, h6 {
89 color: orange !important;
90 }
91 ```