Skip to Content
0 Votes

Changes for page Start here if you're new

Last modified by Ryan C on 2025/06/28 04:59
From version 12.1
edited by Ryan C
on 2025/03/16 01:25
Change comment: There is no comment for this version
To version 6.1
edited by Ryan C
on 2025/03/16 01:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,22 +2,22 @@
2 2  
3 3  ----
4 4  
5 -== ==
5 +== Getting Started with XWiki ==
6 6  
7 +This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
8 +
7 7  == ๐Ÿ“– Table of Contents: ==
8 8  
9 -{{toc/}}
11 +* [[Editing with the WYSIWYG Editor>>https://chatgpt.com/c/67d66d62-3244-800a-8974-570f38118948#editing-pages]]
12 +* [[Inserting Attachments and Images>>https://chatgpt.com/c/67d66d62-3244-800a-8974-570f38118948#attachments]]
13 +* [[Using the / Macro Shortcut>>https://chatgpt.com/c/67d66d62-3244-800a-8974-570f38118948#macros]]
14 +* [[Basic Formatting and Links>>https://chatgpt.com/c/67d66d62-3244-800a-8974-570f38118948#formatting]]
15 +* [[Useful Tips>>https://chatgpt.com/c/67d66d62-3244-800a-8974-570f38118948#tips]]
10 10  
11 11  ----
12 12  
13 -== Getting Started with XWiki ==
19 +== ๐Ÿ“Ž Attachments and Images ==
14 14  
15 -This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
16 -
17 -== ==
18 -
19 -== ๐Ÿ“Ž **Attachments and Images** ==
20 -
21 21  You can easily upload files and images directly from the WYSIWYG editor:
22 22  
23 23  **Uploading Attachments:**
... ... @@ -27,7 +27,7 @@
27 27  * Drag-and-drop or select your file to upload it instantly.
28 28  * Uploaded files will automatically be listed as attachments at the bottom of your page.
29 29  
30 -=== **Inserting Images with Enlargable Thumbnails** ===
30 +=== Inserting Images with Enlargable Thumbnails ===
31 31  
32 32  1. In the editor, click the **"Insert Image"** icon from the toolbar.
33 33  1. Upload or select the image.
... ... @@ -35,7 +35,7 @@
35 35  
36 36  ----
37 37  
38 -== โšก **Using the / Macro Shortcut** ==
38 +== โšก Using the / Macro Shortcut ==
39 39  
40 40  The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
41 41  
... ... @@ -52,7 +52,7 @@
52 52  
53 53  ----
54 54  
55 -== โœ๏ธ**ย Basic Formatting and Links (Quick Guide)** ==
55 +== โœ๏ธ Basic Formatting and Links (Quick Guide) ==
56 56  
57 57  * **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
58 58  * **Italic text**: Select text, click "Italic" in the toolbar or use Ctrl+I.
... ... @@ -62,7 +62,7 @@
62 62  
63 63  ----
64 64  
65 -== ๐Ÿ” **Useful Tips & Best Practices** ==
65 +== ๐Ÿ” Useful Tips & Best Practices ==
66 66  
67 67  * **Save drafts frequently:** Press Ctrl+S regularly.
68 68  * **Macros** greatly simplify content formattingโ€”use / often.
... ... @@ -71,41 +71,42 @@
71 71  
72 72  ----
73 73  
74 -= โšก**Guests can contribute** =
74 += โšกGuests can contribute =
75 75  
76 76  1. Guests can edit pages in the main content area without signing up. If this becomes problematic I'll change it but for now I'd like everyone to have access with as little trouble as possible.
77 77  1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
78 78  1. Leave comments, give suggestions, request features.
79 79  
80 -== **Content Guidelines** ==
80 +== Content Guidelines ==
81 81  
82 82  * Ensure your content is well-researched, you don't need to include references in the format of footnotes for your material, but you should try to include studies or links to give credibility to your claims. For instance, just claiming that [[IQ is genetic>>doc:Main Categories.Science & Research.Race & IQ.WebHome]] is genetic wouldn't be valid unless you provide a study backing up that assertion, or more likely link to a page within this site that explains why IQ is not something that is purely determined by environmental factors. If such a page doesn't exist, create it, and start providing studies that show this.
83 83  * Use clear, concise language and avoid using slurs, slang, or troll like language. This isn't supposed to be encyclopedia dramatica, I'd like things to remain relatively mature and well thought out.
84 84  
85 -== **Directories and Page URLs** ==
85 +== Directories and Page URLs ==
86 86  
87 87  * The categories I have made up should cover most content, but if you feel your content doesn't fit under them, feel free to make a new category. Moving pages and reorganizing content in this wiki is very easy.
88 88  
89 +Hereโ€™s a consolidated guide tailored for your XWiki environment, integrating essential syntax, formatting options, and an overview of notable macros to enhance content creation and management.๎ˆ†
89 89  
91 +**1. XWiki Editing Modes**
90 90  
91 -== **XWiki Editing Modes** ==
92 -
93 93  XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:๎ˆ†
94 94  
95 -* **WYSIWYG (What You See Is What You Get) Editor**: Ideal for users unfamiliar with wiki syntax, this editor provides a user-friendly interface resembling traditional word processors. It allows for straightforward text formatting, image insertion, and link creation without delving into markup language. ๎ˆ€cite๎ˆ‚turn0search0๎ˆ๎ˆ†
96 -* **Wiki Editor**: This mode enables direct editing using XWikiโ€™s markup syntax. Itโ€™s suitable for users comfortable with wiki syntax and those requiring precise control over the content structure.๎ˆ†
97 -* **Inline Form Editing**: Used primarily for pages containing structured data or custom applications, this mode presents editable fields directly within the page view, streamlining data entry and updates.๎ˆ†
95 +*. **WYSIWYG (What You See Is What You Get) Editor**: Ideal for users unfamiliar with wiki syntax, this editor provides a user-friendly interface resembling traditional word processors. It allows for straightforward text formatting, image insertion, and link creation without delving into markup language. ๎ˆ€cite๎ˆ‚turn0search0๎ˆ๎ˆ†
96 +*. **Wiki Editor**: This mode enables direct editing using XWikiโ€™s markup syntax. Itโ€™s suitable for users comfortable with wiki syntax and those requiring precise control over the content structure.๎ˆ†
97 +*. **Inline Form Editing**: Used primarily for pages containing structured data or custom applications, this mode presents editable fields directly within the page view, streamlining data entry and updates.๎ˆ†
98 98  
99 -=== **Switching Between Syntaxes** ===
99 +**Switching Between Syntaxes**
100 100  
101 101  XWiki supports multiple syntaxes, including XWiki 2.1, MediaWiki, and others. While itโ€™s possible to switch a pageโ€™s syntax, exercise caution, as certain syntaxes may not fully support WYSIWYG editing. For instance, changing a page to MediaWiki syntax might limit the availability of the WYSIWYG editor. ๎ˆ€cite๎ˆ‚turn0search6๎ˆ๎ˆ†
102 102  
103 -== **Essential Formatting Options** ==
103 +**2. Essential Formatting Options**
104 104  
105 105  To ensure content is both engaging and accessible, utilize the following formatting techniques:๎ˆ†
106 106  
107 -* **Headings**: Organize content hierarchically using headings. In XWiki syntax, headings are defined by one to six plus signs (+), corresponding to heading levels 1 to 6.๎ˆ†
107 +*. **Headings**: Organize content hierarchically using headings. In XWiki syntax, headings are defined by one to six plus signs (+), corresponding to heading levels 1 to 6.๎ˆ†
108 108  
109 +
109 109  {{code}}
110 110   + Heading Level 1
111 111   ++ Heading Level 2
... ... @@ -112,96 +112,74 @@
112 112   +++ Heading Level 3
113 113  {{/code}}
114 114  
116 +๎ˆ†
115 115  
116 -=== **Text Formatting** ===
118 +*. **Text Formatting**: Apply styles such as bold, italics, and underlining to emphasize text.๎ˆ†
117 117  
120 +**. **Bold**: Surround text with double asterisks.๎ˆ†
118 118  
119 119  
120 -*
121 -** (((
122 -=== **Bold**: Surround text with double asterisks. ===
123 -)))
124 -
125 125  {{code}}
126 126  **bold text**
127 127  {{/code}}
126 +**. **Italics**: Use double underscores.๎ˆ†
128 128  
129 129  
130 -*
131 -** (((
132 -=== **Italics**: Use double underscores. ===
133 -)))
134 -
135 135  {{code}}
136 136  __italic text__
137 137  {{/code}}
132 +**. **Underline**: Enclose text with double tildes.๎ˆ†
138 138  
139 139  
140 -*
141 -** (((
142 -=== **Underline**: Enclose text with double tildes. ===
143 -)))
144 -
145 145  {{code}}
146 146  ~~underlined text~~
147 147  {{/code}}
138 +*. **Lists**: Create ordered and unordered lists for structured information.๎ˆ†
148 148  
140 +**. **Unordered List**: Begin lines with asterisk (*) or hyphen (-).๎ˆ†
149 149  
150 -*
151 -** (((
152 -=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
153 -)))
154 154  
155 155  {{code}}
156 156  * Item 1
157 157  * Item 2
158 158  {{/code}}
147 +**. **Ordered List**: Start lines with a number followed by a period.๎ˆ†
159 159  
160 160  
161 -*
162 -** (((
163 -=== **Ordered List**: Start lines with a number followed by a period. ===
164 -)))
165 -
166 166  {{code}}
167 167  1. First item
168 168  2. Second item
169 169  {{/code}}
154 +*. **Links**: Insert internal and external links to connect related content.๎ˆ†
170 170  
156 +**. **Internal Link**: Use square brackets with the page name.๎ˆ†
171 171  
172 -== **Links** ==
173 173  
174 -
175 -
176 -==== **Internal Link**: Use square brackets with the page name. ====
177 -
178 178  {{code}}
179 179  [[PageName]]
180 180  {{/code}}
162 +**. **External Link**: Provide the URL directly.๎ˆ†
181 181  
182 182  
183 -
184 -==== **External Link**: Provide the URL directly. ====
185 -
186 186  {{code}}
187 187  [https://www.example.com]
188 188  {{/code}}
168 +*. **Images**: Embed images to enrich content.๎ˆ†
189 189  
190 -(((
191 -=== **Images** ===
192 -)))
193 193  
194 194  {{code}}
195 195   [[image:example.jpg]]
196 196  {{/code}}
197 197  
175 +๎ˆ†
198 198  
199 -== **Utilizing XWiki Macros** ==
177 +**3. Utilizing XWiki Macros**
200 200  
201 201  Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:๎ˆ†
202 202  
203 -**Box Macro**: Encapsulates content within a styled box, useful for highlighting information.
181 +1. **Box Macro**: Encapsulates content within a styled box, useful for highlighting information.๎ˆ†
204 204  
183 +
205 205  {{code}}
206 206  {{box}}
207 207  Your content here.
... ... @@ -208,8 +208,9 @@
208 208  {{/box}}
209 209  {{/code}}
210 210  
190 +๎ˆ†
191 +1. **Info Macro**: Displays an informational message, often used for tips or notes.๎ˆ†
211 211  
212 -=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
213 213  
214 214  {{code}}
215 215  {{info}}
... ... @@ -217,8 +217,9 @@
217 217  {{/info}}
218 218  {{/code}}
219 219  
200 +๎ˆ†
201 +1. **Warning Macro**: Highlights warnings or important notices.๎ˆ†
220 220  
221 -=== **Warning Macro**: Highlights warnings or important notices. ===
222 222  
223 223  {{code}}
224 224  {{warning}}
... ... @@ -226,8 +226,9 @@
226 226  {{/warning}}
227 227  {{/code}}
228 228  
210 +๎ˆ†
211 +1. **Code Macro**: Renders code snippets with syntax highlighting.๎ˆ†
229 229  
230 -=== **Code Macro**: Renders code snippets with syntax highlighting. ===
231 231  
232 232  {{code}}
233 233  {{code language="python"}}
... ... @@ -236,8 +236,9 @@
236 236  {{/code}}
237 237  {{/code}}
238 238  
221 +๎ˆ†
222 +1. **Gallery Macro**: Creates an image gallery from attached images.๎ˆ†
239 239  
240 -=== **Gallery Macro**: Creates an image gallery from attached images. ===
241 241  
242 242  {{code}}
243 243  {{gallery}}
... ... @@ -246,29 +246,33 @@
246 246  {{/gallery}}
247 247  {{/code}}
248 248  
232 +๎ˆ†
233 +1. **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings.๎ˆ†
249 249  
250 -=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
251 251  
252 252  {{code}}
253 253  {{toc/}}
254 254  {{/code}}
255 255  
240 +๎ˆ†
241 +1. **Include Macro**: Embeds content from another page.๎ˆ†
256 256  
257 -=== **Include Macro**: Embeds content from another page. ===
258 258  
259 259  {{code}}
260 260  {{include reference="PageName"/}}
261 261  {{/code}}
262 262  
248 +๎ˆ†
249 +1. **Display Macro**: Displays the content of another document or an object property.๎ˆ†
263 263  
264 -=== **Display Macro**: Displays the content of another document or an object property. ===
265 265  
266 266  {{code}}
267 267  {{display reference="PageName"/}}
268 268  {{/code}}
269 269  
256 +๎ˆ†
257 +1. **Velocity Macro**: Executes Velocity scripts for dynamic content generation.๎ˆ†
270 270  
271 -=== **Velocity Macro**: Executes Velocity scripts for dynamic content generation. ===
272 272  
273 273  {{code}}
274 274  {{velocity}}
... ... @@ -277,4 +277,5 @@
277 277  {{/velocity}}
278 278  {{/code}}
279 279  
280 -
267 +๎ˆ†
268 +1. **HTML Macro**: Allows the inclusion of