Most Important Configurations
Last modified by chrisby on 2024/03/30 17:19
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.
Delete non-required extensions
- Extensions > Extensions > In the selection menu, select "Installed Extensions" > Search for "Tour Application", "Help Application" and "Sandbox Application" and uninstall them
Upload Logo (displayed in the upper left corner of the website)
- Look & Feel > Themes > Color Theme > COLOR THEME > Customize > Logos > Choose an attachment > Browse > Upload and select > Safe & View
Add a tab bar below the website header
- Look & Feel > Menus > Add new entry > (create a menu, for example "Header Menu")
- Add links to each bullet point so that users who click on the tab are directed to the appropriate page.
- At the bottom of the Menu page: Menu Display Location = After the page header; Menu Visibility Scope = Global.
Adapt navigation panel items to your needs (the boxes at the edges like "Navigation" or "Recently Created")
- Look & Feel > Panels > Panel List
Change browser tab title
- Look & Feel > Presentation > Header > Title > Remove the " - XWiki"
- 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. For example, svg files must be named "icons.xwiki.favicon.svg". > Upload and select image > Save & View
Enable justification in editor
- Editing > WYSIWYG Editor
- Default WYSIWYG Editor > CKEditor > Save (Note: There are two "Save" buttons on this page.)
- CKEditor > Disables Plugins > Open selection of disabled plugins > uncheck "justify" plugin > click on "Save" button at the bottom
Disable registration of new accounts
- 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 for further details.
Allow comments feature for unregistered users
- Users & Rights > Rights > Remove the "Comment" check for each group. This implicitly allows all groups (including unregistered users) to use the comments feature.
Set up mailing
- Mail > Mail Sending > Email address to send from > (enter the necessary fields to enable XWiki's mailing functionality)
- Users & Rights > Registration > User Email verification > Yes
Adapt the timezone
- Content > Localization > Date/Time > Timezone
Use Markdown as page editing syntax
- Extensions > Extensions > Install CommonMark Markdown Syntax 1.2.
- Editing > Syntaxes > Disabled syntaxes
- Enable "CommonMark Markdown 1.2
- Uncheck "XWiki 2.1
- Saving
- Newly created articles automatically use Markdown syntax by default. When editing, simply click the "Source" button to open the Markdown source editor.
- 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:
- 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.
- Sometimes manual adjustments are required after conversion, as it does not always work as desired.
Adapt the footer - Hide XWiki version and add copyright information.
- Look & Feel > Presentation > Footer > Here you can find the fields "Copyright" and "Version".
- 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 is an example:
The contents of this website are available under the <a href="https://creativecommons.org/publicdomain/zero/1.0/deed.en">CC0 1.0 Universal license</a>; additional terms may apply.
Hide Personal Profile Data
- Users & Rights > User Profile > Displayed sections > Remove 'contact' > Save
Dark Theme
- Look & Feel > Themes > Color Theme
- Manage Color Themes > "Darkly" Theme > Use this theme
- Customize > Advanced > Add the code below at the end and then "Save & View":
Code to add:
// Own customizations
// .code span, // concerns code in 'code' macro
#var-lessCode,
#adminsearchmenu,
.macro-parameter-field textarea,
.form-control, // concerns credentials in login screen
.xwikipaneltitle {
color: white !important;
}
// Global search bar at the upper right has a white background by default, so the white default font would not make sense here.
#headerglobalsearchinput {
color: black !important;
}
// Removes white shadow from text in navigation menu
.jstree-anchor {
text-shadow: none !important;
}
h1, h2, h3, h4, h5, h6 { // All headings in pages
color: orange !important;
}
#menu-horizontal-Menu-Header-Menu-WebHome a, // The menu below the Crispy Coding header with logo.
.breadcrumb a { // breadcrumb links at the top of every page and in search results
color: #0ce3ac !important;
}
strong, // all bold text in articles
.search-text-highlight { // Highlight searched words in articles when using the global search bar in the upper right corner.
color: #33ccff !important;
}
// When being in 'source' mode in editor.
#cke_1_contents textarea {
background-color: #333333 !important;
}
// .code span, // concerns code in 'code' macro
#var-lessCode,
#adminsearchmenu,
.macro-parameter-field textarea,
.form-control, // concerns credentials in login screen
.xwikipaneltitle {
color: white !important;
}
// Global search bar at the upper right has a white background by default, so the white default font would not make sense here.
#headerglobalsearchinput {
color: black !important;
}
// Removes white shadow from text in navigation menu
.jstree-anchor {
text-shadow: none !important;
}
h1, h2, h3, h4, h5, h6 { // All headings in pages
color: orange !important;
}
#menu-horizontal-Menu-Header-Menu-WebHome a, // The menu below the Crispy Coding header with logo.
.breadcrumb a { // breadcrumb links at the top of every page and in search results
color: #0ce3ac !important;
}
strong, // all bold text in articles
.search-text-highlight { // Highlight searched words in articles when using the global search bar in the upper right corner.
color: #33ccff !important;
}
// When being in 'source' mode in editor.
#cke_1_contents textarea {
background-color: #333333 !important;
}