Wiki source code of Most Important Configurations
Last modified by chrisby on 2024/03/30 17:19
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 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**. | ||
| 2 | |||
| 3 | ###### Delete non-required extensions | ||
| 4 | |||
| 5 | * Extensions > Extensions > In the selection menu, select "Installed Extensions" > Search for "Tour Application", "Help Application" and "Sandbox Application" and uninstall them | ||
| 6 | |||
| 7 | ###### Upload Logo (displayed in the upper left corner of the website) | ||
| 8 | |||
| 9 | * Look & Feel > Themes > Color Theme > COLOR THEME > Customize > Logos > Choose an attachment > Browse > Upload and select > Safe & View | ||
| 10 | |||
| 11 | ###### Add a tab bar below the website header | ||
| 12 | |||
| 13 | * Look & Feel > Menus > Add new entry > (create a menu, for example "Header Menu") | ||
| 14 | * Add links to each bullet point so that users who click on the tab are directed to the appropriate page. | ||
| 15 | * At the bottom of the Menu page: Menu Display Location = After the page header; Menu Visibility Scope = Global. | ||
| 16 | |||
| 17 | ###### Adapt navigation panel items to your needs (the boxes at the edges like "Navigation" or "Recently Created") | ||
| 18 | |||
| 19 | * Look & Feel > Panels > Panel List | ||
| 20 | |||
| 21 | ###### Change browser tab title | ||
| 22 | |||
| 23 | * Look & Feel > Presentation > Header > Title > Remove the " - XWiki" | ||
| 24 | * 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 | ||
| 25 | |||
| 26 | ###### Enable justification in editor | ||
| 27 | |||
| 28 | * Editing > WYSIWYG Editor | ||
| 29 | * Default WYSIWYG Editor > CKEditor > Save (Note: There are two "Save" buttons on this page.) | ||
| 30 | * CKEditor > Disables Plugins > Open selection of disabled plugins > uncheck "justify" plugin > click on "Save" button at the bottom | ||
| 31 | |||
| 32 | ###### Disable registration of new accounts | ||
| 33 | |||
| 34 | * 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. | ||
| 35 | |||
| 36 | ###### Allow comments feature for unregistered users | ||
| 37 | |||
| 38 | * Users & Rights > Rights > Remove the "Comment" check for each group. This implicitly allows all groups (including unregistered users) to use the comments feature. | ||
| 39 | |||
| 40 | ###### Set up mailing | ||
| 41 | |||
| 42 | * Mail > Mail Sending > Email address to send from > (enter the necessary fields to enable XWiki's mailing functionality) | ||
| 43 | * Users & Rights > Registration > User Email verification > Yes | ||
| 44 | |||
| 45 | ###### Adapt the timezone | ||
| 46 | |||
| 47 | * Content > Localization > Date/Time > Timezone | ||
| 48 | |||
| 49 | ###### Use Markdown as page editing syntax | ||
| 50 | |||
| 51 | * Extensions > Extensions > Install CommonMark Markdown Syntax 1.2. | ||
| 52 | * Editing > Syntaxes > Disabled syntaxes | ||
| 53 | * Enable "CommonMark Markdown 1.2 | ||
| 54 | * Uncheck "XWiki 2.1 | ||
| 55 | * Saving | ||
| 56 | * Newly created articles automatically use Markdown syntax by default. When editing, simply click the "Source" button to open the Markdown source editor. | ||
| 57 | * 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: | ||
| 58 | * 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. | ||
| 59 | * Sometimes manual adjustments are required after conversion, as it does not always work as desired. | ||
| 60 | |||
| 61 | ###### Adapt the footer - Hide XWiki version and add copyright information. | ||
| 62 | |||
| 63 | * Look & Feel > Presentation > Footer > Here you can find the fields "Copyright" and "Version". | ||
| 64 | * 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. | ||
| 65 | |||
| 66 | Here is an example: | ||
| 67 | |||
| 68 | 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. | ||
| 69 | |||
| 70 | ###### Hide Personal Profile Data | ||
| 71 | |||
| 72 | * Users & Rights > User Profile > Displayed sections > Remove 'contact' > Save | ||
| 73 | |||
| 74 | ###### Dark Theme | ||
| 75 | |||
| 76 | * Look & Feel > Themes > Color Theme | ||
| 77 | * Manage Color Themes > "Darkly" Theme > Use this theme | ||
| 78 | * Customize > Advanced > Add the code below at the end and then "Save & View": | ||
| 79 | |||
| 80 | Code to add: | ||
| 81 | |||
| 82 | // Own customizations | ||
| 83 | // .code span, // concerns code in 'code' macro | ||
| 84 | #var-lessCode, | ||
| 85 | #adminsearchmenu, | ||
| 86 | .macro-parameter-field textarea, | ||
| 87 | .form-control, // concerns credentials in login screen | ||
| 88 | .xwikipaneltitle { | ||
| 89 | color: white !important; | ||
| 90 | } | ||
| 91 | |||
| 92 | // Global search bar at the upper right has a white background by default, so the white default font would not make sense here. | ||
| 93 | #headerglobalsearchinput { | ||
| 94 | color: black !important; | ||
| 95 | } | ||
| 96 | |||
| 97 | // Removes white shadow from text in navigation menu | ||
| 98 | .jstree-anchor { | ||
| 99 | text-shadow: none !important; | ||
| 100 | } | ||
| 101 | |||
| 102 | h1, h2, h3, h4, h5, h6 { // All headings in pages | ||
| 103 | color: orange !important; | ||
| 104 | } | ||
| 105 | |||
| 106 | #menu-horizontal-Menu-Header-Menu-WebHome a, // The menu below the Crispy Coding header with logo. | ||
| 107 | .breadcrumb a { // breadcrumb links at the top of every page and in search results | ||
| 108 | color: #0ce3ac !important; | ||
| 109 | } | ||
| 110 | |||
| 111 | strong, // all bold text in articles | ||
| 112 | .search-text-highlight { // Highlight searched words in articles when using the global search bar in the upper right corner. | ||
| 113 | color: #33ccff !important; | ||
| 114 | } | ||
| 115 | |||
| 116 | // When being in 'source' mode in editor. | ||
| 117 | #cke_1_contents textarea { | ||
| 118 | background-color: #333333 !important; | ||
| 119 | } |