Skip to Content
Last modified by chrisby on 2024/03/30 17:19
From version 3.9
edited by chrisby
on 2023/11/18 14:57
Change comment: There is no comment for this version
To version 1.6
edited by chrisby
on 2023/09/03 16:40
Change comment: Update document after refactoring.

Summary

Details

Page properties
Syntax
... ... @@ -1,1 +1,1 @@
1 -Markdown 1.2
1 +XWiki 2.1
Content
... ... @@ -1,89 +1,43 @@
1 +(% style="text-align: justify;" %)
1 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 2  
3 -###### Delete non-required extensions
4 4  
5 -* Extensions > Extensions > In the selection menu, select "Installed Extensions" > Search for "Tour Application", "Help Application" and "Sandbox Application" and uninstall them
5 +(% style="text-align: justify;" %)
6 +=== Measures ===
6 6  
7 -###### Upload Logo (displayed in the upper left corner of the website)
8 +* Delete non-required extensions:
9 +** Extensions > Extensions > In the selection menu, select "Installed Extensions" > Search for "Tour Application", "Help Application" and "Sandbox Application" and uninstall them
10 +* Upload Logo (displayed in the upper left corner of the website):
11 +** Look & Feel > Themes > Color Theme > COLOR THEME > Customize > Logos > Choose an attachment > Browse > Upload and select > Safe & View
12 +* Add a tab bar below the website header:
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 +* Adapt navigation panel items to your needs (the boxes at the edges like "Navigation" or "Recently Created")
17 +** Look & Feel > Panels > Panel List
18 +* Adapt the footer - Hide XWiki version and add copyright information.
19 +** Look & Feel > Presentation > Footer > Here you can find the fields "Copyright" and "Version".
20 +** 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:
8 8  
9 -* Look & Feel > Themes > Color Theme > COLOR THEME > Customize > Logos > Choose an attachment > Browse > Upload and select > Safe & View
22 +{{code}}
23 +The contents of this website are available under the <a style="text-decoration:underline;" href="https://creativecommons.org/publicdomain/zero/1.0/deed.en">CC0 1.0 Universal license</a>; additional terms may apply.
10 10  
11 -###### Add a tab bar below the website header
25 +The contents of this website are available under the <a style="text-decoration:underline;" href="https://creativecommons.org/licenses/by/4.0/">Attribution 4.0 International</a>; additional terms may apply.
26 +{{/code}}
12 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 **below**
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 -* Edit > Syntax > 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. Here are two examples when using Markdown syntax as described above:
65 -
66 -```
67 -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.
68 -The contents of this website are available under the [Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/); additional terms may apply.
69 -```
70 -
71 -###### **Dark Theme**
72 -
73 -* Look & Feel > Themes > Color Theme > COLOR_THEMES
74 - * Manage Color Themes > "Darkly" Theme > Use this theme
75 - * Customize > Advanced > Add the following code at the end and then "Save & View":
76 -
77 -```CSS
78 -// Own customizations
79 -#var-lessCode,
80 -.macro-parameter-field textarea,
81 -.code span,
82 -.xwikipaneltitle {
83 - color: white !important;
84 -}
85 -
86 -h1, h2, h3, h4, h5, h6 {
87 - color: orange !important;
88 -}
89 -```
28 +* Change browser tab title:
29 +** Look & Feel > Presentation > Header > Title > Remove the " - XWiki"
30 +** 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
31 +* Enable justification in editor:
32 +** Editing > WYSIWYG Editor >
33 +*** Default WYSIWYG Editor > CKEditor > Save (Note: There are two "Save" buttons on this page.)
34 +*** CKEditor > Disables Plugins > Open selection of disabled plugins > uncheck "justify" plugin > click on "Save" button **below**
35 +* Disable registration of new accounts:
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 +* Allow comments feature for unregistered users:
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 +* Set up mailing:
40 +** Mail > Mail Sending > Email address to send from > (enter the necessary fields to enable XWiki's mailing functionality)
41 +** Users & Rights > Registration > User Email verification > Yes
42 +* Adapt the timezone:
43 +** Content > Localization > Date/Time > Timezone