0 Votes

Changes for page Start here if you're new

Last modified by Ryan C on 2025/06/28 04:59

From version 16.1
edited by Ryan C
on 2025/05/14 13:30
Change comment: There is no comment for this version
To version 8.1
edited by Ryan C
on 2025/03/16 01:18
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,8 +2,10 @@
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 9  {{toc/}}
... ... @@ -10,12 +10,6 @@
10 10  
11 11  ----
12 12  
13 -== Getting Started with XWiki ==
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 19  == πŸ“Ž **Attachments and Images** ==
20 20  
21 21  You can easily upload files and images directly from the WYSIWYG editor:
... ... @@ -96,6 +96,10 @@
96 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 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  
95 +=== **Switching Between Syntaxes** ===
96 +
97 +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ξˆξˆ†
98 +
99 99  == **Essential Formatting Options** ==
100 100  
101 101  To ensure content is both engaging and accessible, utilize the following formatting techniques:ξˆ†
... ... @@ -112,8 +112,7 @@
112 112  === **Text Formatting** ===
113 113  
114 114  
115 -
116 -*
115 +*
117 117  ** (((
118 118  === **Bold**: Surround text with double asterisks. ===
119 119  )))
... ... @@ -122,8 +122,7 @@
122 122  **bold text**
123 123  {{/code}}
124 124  
125 -
126 -*
124 +*
127 127  ** (((
128 128  === **Italics**: Use double underscores. ===
129 129  )))
... ... @@ -132,8 +132,7 @@
132 132  __italic text__
133 133  {{/code}}
134 134  
135 -
136 -*
133 +*
137 137  ** (((
138 138  === **Underline**: Enclose text with double tildes. ===
139 139  )))
... ... @@ -142,8 +142,10 @@
142 142  ~~underlined text~~
143 143  {{/code}}
144 144  
145 -
146 146  *
143 +*
144 +
145 +*
147 147  ** (((
148 148  === **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
149 149  )))
... ... @@ -153,8 +153,7 @@
153 153  * Item 2
154 154  {{/code}}
155 155  
156 -
157 -*
155 +*
158 158  ** (((
159 159  === **Ordered List**: Start lines with a number followed by a period. ===
160 160  )))
... ... @@ -164,11 +164,15 @@
164 164  2. Second item
165 165  {{/code}}
166 166  
165 +* (((
166 +=== ===
167 +)))
168 +* (((
169 +=== **Links** ===
170 +)))
167 167  
168 -== **Links** ==
169 169  
170 170  
171 -
172 172  ==== **Internal Link**: Use square brackets with the page name. ====
173 173  
174 174  {{code}}
... ... @@ -175,15 +175,16 @@
175 175  [[PageName]]
176 176  {{/code}}
177 177  
178 -
179 -
180 +*
181 +** (((
180 180  ==== **External Link**: Provide the URL directly. ====
183 +)))
181 181  
182 182  {{code}}
183 183  [https://www.example.com]
184 184  {{/code}}
185 185  
186 -(((
189 +* (((
187 187  === **Images** ===
188 188  )))
189 189  
... ... @@ -196,17 +196,17 @@
196 196  
197 197  Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:ξˆ†
198 198  
199 -== Embed Macro ==
202 +1. **Box Macro**: Encapsulates content within a styled box, useful for highlighting information.ξˆ†
200 200  
201 -The Embed macro shows external content like YouTube videos.
204 +{{code}}
205 +{{box}}
206 +Your content here.
207 +{{/box}}
208 +{{/code}}
202 202  
203 -{{example}}
204 -{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
205 -{{/example}}
206 206  
211 +=== **Info Macro**: Displays an informational message, often used for tips or notes.ξˆ† ===
207 207  
208 -=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
209 -
210 210  {{code}}
211 211  {{info}}
212 212  This is an informational note.
... ... @@ -214,18 +214,17 @@
214 214  {{/code}}
215 215  
216 216  
217 -== Footnote Macro ==
220 +=== **Warning Macro**: Highlights warnings or important notices.ξˆ† ===
218 218  
219 -The Footnote macro adds footnotes to the page.
222 +{{code}}
223 +{{warning}}
224 +Caution: Proceed with care.
225 +{{/warning}}
226 +{{/code}}
220 220  
221 -{{example}}
222 -This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
223 -{{putFootnotes/}}
224 -{{/example}}
225 225  
229 +=== **Code Macro**: Renders code snippets with syntax highlighting.ξˆ† ===
226 226  
227 -=== **Code Macro**: Renders code snippets with syntax highlighting. ===
228 -
229 229  {{code}}
230 230  {{code language="python"}}
231 231  def hello_world():
... ... @@ -234,7 +234,7 @@
234 234  {{/code}}
235 235  
236 236  
237 -=== **Gallery Macro**: Creates an image gallery from attached images. ===
239 +=== **Gallery Macro**: Creates an image gallery from attached images.ξˆ† ===
238 238  
239 239  {{code}}
240 240  {{gallery}}
... ... @@ -250,62 +250,28 @@
250 250  {{toc/}}
251 251  {{/code}}
252 252  
253 -== Video Macro ==
254 254  
255 -The Video macro embeds videos.
256 +=== **Include Macro**: Embeds content from another page. ===
256 256  
257 -{{example}}
258 -{{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
259 -{{/example}}
258 +{{code}}
259 +{{include reference="PageName"/}}
260 +{{/code}}
260 260  
261 -== Expandable Macro ==
262 -The following example demonstrates how to present complex information cleanly using `{{expandable}}` and `{{example}}`.
263 263  
264 -{{example}}
265 -
266 -
267 -{{expandable summary="🧠 Study: Survey of Expert Opinion on Intelligence"}}
268 -**Source:** *Intelligence (Elsevier)*
269 -**Date:** *2019*
270 -**Authors:** *Heiner Rindermann, David Becker, Thomas R. Coyle*
271 -**DOI:** [10.1016/j.intell.2019.101406](https://doi.org/10.1016/j.intell.2019.101406)
272 -**Subject:** *Psychology, Intelligence Research*
263 +=== **Display Macro**: Displays the content of another document or an object property. ===
273 273  
274 -{{expandable summary="πŸ“Š Key Statistics"}}
275 -- Survey of **102 intelligence experts**
276 -- **90% from Western countries**, **83% male**
277 -- **54% left-liberal**, **24% conservative**
278 -- **50/50 split** on genetic vs environmental causes of Black-White IQ gap
279 -{{/expandable}}
265 +{{code}}
266 +{{display reference="PageName"/}}
267 +{{/code}}
280 280  
281 -{{expandable summary="πŸ”¬ Findings"}}
282 -- Support for **g-factor theory**
283 -- Agreement on **heritability of intelligence**
284 -- Political lean: left = environmental, right = genetic causes
285 -{{/expandable}}
286 286  
287 -{{expandable summary="πŸ“ Critique"}}
288 -- Largest expert survey on intelligence
289 -- **Western-only sample**, possible **self-selection bias**
290 -{{/expandable}}
270 +=== **Velocity Macro**: Executes Velocity scripts for dynamic content generation. ===
291 291  
292 -{{expandable summary="πŸ“Œ Relevance"}}
293 -- Shows **ideological divide** in science
294 -- Highlights **media vs expert disconnect**
295 -{{/expandable}}
272 +{{code}}
273 +{{velocity}}
274 +#set($greeting = "Hello, $user.name!")
275 +$greeting
276 +{{/velocity}}
277 +{{/code}}
296 296  
297 -{{expandable summary="πŸ” Explore More"}}
298 -- Global surveys on intelligence beliefs
299 -- Media analysis follow-up studies
300 -{{/expandable}}
301 -
302 -{{expandable summary="πŸ“„ Download"}}
303 -[[Download Study>>attach:10.1016_j.intell.2019.101406.pdf]]
304 -{{/expandable}}
305 -{{/expandable}}
306 -{{/example}}
307 -
308 -
309 -== See Also: ==
310 -
311 -[[Syntax Help official documentation for a full list of formatting options>>doc:XWiki.XWikiSyntax]]
279 +