0 Votes

Changes for page Start here if you're new

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

From version 22.1
edited by Ryan C
on 2025/05/14 13:41
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,184 +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 -The `{{example}}` macro in XWiki is an underrated powerhouse—great for *teaching*, *showcasing macros*, *hiding complex markup*, and *letting users play with source-output pairs*. Here are some **highly effective and interesting uses**:
16 -
17 ----
18 -
19 -## 🧪 1. **Macro Showcase: Source-to-Output Toggle**
20 -
21 -Show how a macro works without cluttering the page with raw syntax.
22 -
23 -```xwiki
24 -== Gallery Macro ==
25 -{{example}}
26 -{{gallery}}
27 -[[image:photo1.jpg]]
28 -[[image:photo2.jpg]]
29 -{{/gallery}}
30 -{{/example}}
31 -```
32 -
33 -**Why it's good:** New users see both source and result without confusion.
34 -
35 ----
36 -
37 -## 📝 2. **Editable Template Snippets**
38 -
39 -Use `{{example}}` to store reusable content that users can copy, paste, and modify.
40 -
41 -```xwiki
42 -== Boilerplate Box ==
43 -{{example}}
44 -{{box cssClass="highlight"}}
45 -Insert your highlighted content here.
46 -{{/box}}
47 -{{/example}}
48 -```
49 -
50 ----
51 -
52 -## 🎓 3. **Educational Tutorials (e.g., Velocity or Groovy)**
53 -
54 -Teach scripting with real, live code examples.
55 -
56 -```xwiki
57 -== Velocity Greeting ==
58 -{{example}}
59 -{{velocity}}
60 -#set($name = "Visitor")
61 -Hello, $name!
62 -{{/velocity}}
63 -{{/example}}
64 -```
65 -
66 ----
67 -
68 -## 🎯 4. **Comparing Macro Parameters**
69 -
70 -Demonstrate how different macro parameters change output—side-by-side.
71 -
72 -```xwiki
73 -== Info vs Warning ==
74 -{{example}}
75 -{{info}}This is an info box.{{/info}}
76 -
77 -{{warning}}This is a warning box.{{/warning}}
78 -{{/example}}
79 -```
80 -
81 ----
82 -
83 -## 🧩 5. **Interactive Data Blocks (TOC, Footnotes, etc.)**
84 -
85 -Visually show what happens when you use certain macros together.
86 -
87 -```xwiki
88 -== Footnote Demo ==
89 -{{example}}
90 -This claim needs a source{{footnote}}Here it is.{{/footnote}}.
91 -{{putFootnotes/}}
92 -{{/example}}
93 -```
94 -
95 ----
96 -
97 -## 🧪 6. **Live Scripting Playgrounds**
98 -
99 -Embed small self-contained scripting playgrounds where users can view or modify dynamic output.
100 -
101 -```xwiki
102 -== Groovy Lookup ==
103 -{{example}}
104 -{{groovy}}
105 -def now = new Date()
106 -println("Current time: " + now)
107 -{{/groovy}}
108 -{{/example}}
109 -```
110 -
111 ----
112 -
113 -## 📦 7. **Component/API Call Demos**
114 -
115 -Useful for devs exploring the API.
116 -
117 -```xwiki
118 -== Access Current User ==
119 -{{example}}
120 -{{velocity}}
121 -Current user: **$xcontext.user**
122 -{{/velocity}}
123 -{{/example}}
124 -```
125 -
126 ----
127 -
128 -## 📘 8. **Expandable Wiki Templates with Output**
129 -
130 -Pair `{{example}}` with `{{expandable}}` for full disclosure without visual clutter.
131 -
132 -```xwiki
133 -== Expandable Summary ==
134 -{{example}}
135 -{{expandable summary="🧠 Study Summary"}}
136 -Key findings go here.
137 -{{/expandable}}
138 -{{/example}}
139 -```
140 -
141 ----
142 -
143 -## 🔧 9. **Syntax Training: Bad vs Good**
144 -
145 -Side-by-side "Do this, not that" with toggles.
146 -
147 -```xwiki
148 -== List Formatting ==
149 -{{example}}
150 -*Bad formatting*
151 -* use - inconsistently
152 -** Good formatting:
153 - * Consistent bullet style
154 - * Indented items properly
155 -{{/example}}
156 -```
157 -
158 ----
159 -
160 -## 💡 Bonus Tip: Combine `{{example}}` + `{{code}}` for Highlighted Snippets
161 -
162 -```xwiki
163 -== Python Code ==
164 -{{example}}
165 -{{code language="python"}}
166 -def greet():
167 - print("Hello World")
168 -{{/code}}
169 -{{/example}}
170 -```
171 -
172 ----
173 -
174 -Want me to generate a panel with these uses or make a macro gallery page pre-filled with them?
175 -
176 -
177 -This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
178 -
179 -== ==
180 -
181 -== 📎 **Attachments and Images** ==
182 -
183 183  You can easily upload files and images directly from the WYSIWYG editor:
184 184  
185 185  **Uploading Attachments:**
... ... @@ -189,7 +189,7 @@
189 189  * Drag-and-drop or select your file to upload it instantly.
190 190  * Uploaded files will automatically be listed as attachments at the bottom of your page.
191 191  
192 -=== **Inserting Images with Enlargable Thumbnails** ===
30 +=== Inserting Images with Enlargable Thumbnails ===
193 193  
194 194  1. In the editor, click the **"Insert Image"** icon from the toolbar.
195 195  1. Upload or select the image.
... ... @@ -197,7 +197,7 @@
197 197  
198 198  ----
199 199  
200 -== ⚡ **Using the / Macro Shortcut** ==
38 +== ⚡ Using the / Macro Shortcut ==
201 201  
202 202  The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
203 203  
... ... @@ -214,7 +214,7 @@
214 214  
215 215  ----
216 216  
217 -== ✏️** Basic Formatting and Links (Quick Guide)** ==
55 +== ✏️ Basic Formatting and Links (Quick Guide) ==
218 218  
219 219  * **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
220 220  * **Italic text**: Select text, click "Italic" in the toolbar or use Ctrl+I.
... ... @@ -224,7 +224,7 @@
224 224  
225 225  ----
226 226  
227 -== 🔍 **Useful Tips & Best Practices** ==
65 +== 🔍 Useful Tips & Best Practices ==
228 228  
229 229  * **Save drafts frequently:** Press Ctrl+S regularly.
230 230  * **Macros** greatly simplify content formatting—use / often.
... ... @@ -233,37 +233,42 @@
233 233  
234 234  ----
235 235  
236 -= ⚡**Guests can contribute** =
74 += ⚡Guests can contribute =
237 237  
238 238  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.
239 239  1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
240 240  1. Leave comments, give suggestions, request features.
241 241  
242 -== **Content Guidelines** ==
80 +== Content Guidelines ==
243 243  
244 244  * 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.
245 245  * 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.
246 246  
247 -== **Directories and Page URLs** ==
85 +== Directories and Page URLs ==
248 248  
249 249  * 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.
250 250  
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.
251 251  
91 +**1. XWiki Editing Modes**
252 252  
253 -== **XWiki Editing Modes** ==
254 -
255 255  XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:
256 256  
257 -* **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
258 -* **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.
259 -* **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.
260 260  
261 -== **Essential Formatting Options** ==
99 +**Switching Between Syntaxes**
262 262  
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 +
103 +**2. Essential Formatting Options**
104 +
263 263  To ensure content is both engaging and accessible, utilize the following formatting techniques:
264 264  
265 -* **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.
266 266  
109 +
267 267  {{code}}
268 268   + Heading Level 1
269 269   ++ Heading Level 2
... ... @@ -270,104 +270,83 @@
270 270   +++ Heading Level 3
271 271  {{/code}}
272 272  
116 +
273 273  
274 -=== **Text Formatting** ===
118 +*. **Text Formatting**: Apply styles such as bold, italics, and underlining to emphasize text.
275 275  
120 +**. **Bold**: Surround text with double asterisks.
276 276  
277 277  
278 -*
279 -** (((
280 -=== **Bold**: Surround text with double asterisks. ===
281 -)))
282 -
283 283  {{code}}
284 284  **bold text**
285 285  {{/code}}
126 +**. **Italics**: Use double underscores.
286 286  
287 287  
288 -*
289 -** (((
290 -=== **Italics**: Use double underscores. ===
291 -)))
292 -
293 293  {{code}}
294 294  __italic text__
295 295  {{/code}}
132 +**. **Underline**: Enclose text with double tildes.
296 296  
297 297  
298 -*
299 -** (((
300 -=== **Underline**: Enclose text with double tildes. ===
301 -)))
302 -
303 303  {{code}}
304 304  ~~underlined text~~
305 305  {{/code}}
138 +*. **Lists**: Create ordered and unordered lists for structured information.
306 306  
140 +**. **Unordered List**: Begin lines with asterisk (*) or hyphen (-).
307 307  
308 -*
309 -** (((
310 -=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
311 -)))
312 312  
313 313  {{code}}
314 314  * Item 1
315 315  * Item 2
316 316  {{/code}}
147 +**. **Ordered List**: Start lines with a number followed by a period.
317 317  
318 318  
319 -*
320 -** (((
321 -=== **Ordered List**: Start lines with a number followed by a period. ===
322 -)))
323 -
324 324  {{code}}
325 325  1. First item
326 326  2. Second item
327 327  {{/code}}
154 +*. **Links**: Insert internal and external links to connect related content.
328 328  
156 +**. **Internal Link**: Use square brackets with the page name.
329 329  
330 -== **Links** ==
331 331  
332 -
333 -
334 -==== **Internal Link**: Use square brackets with the page name. ====
335 -
336 336  {{code}}
337 337  [[PageName]]
338 338  {{/code}}
162 +**. **External Link**: Provide the URL directly.
339 339  
340 340  
341 -
342 -==== **External Link**: Provide the URL directly. ====
343 -
344 344  {{code}}
345 345  [https://www.example.com]
346 346  {{/code}}
168 +*. **Images**: Embed images to enrich content.
347 347  
348 -(((
349 -=== **Images** ===
350 -)))
351 351  
352 352  {{code}}
353 353   [[image:example.jpg]]
354 354  {{/code}}
355 355  
175 +
356 356  
357 -== **Utilizing XWiki Macros** ==
177 +**3. Utilizing XWiki Macros**
358 358  
359 359  Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
360 360  
361 -== Embed Macro ==
181 +1. **Box Macro**: Encapsulates content within a styled box, useful for highlighting information.
362 362  
363 -The Embed macro shows external content like YouTube videos.
364 364  
365 -{{example}}
366 -{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
367 -{{/example}}
184 +{{code}}
185 +{{box}}
186 +Your content here.
187 +{{/box}}
188 +{{/code}}
368 368  
190 +
191 +1. **Info Macro**: Displays an informational message, often used for tips or notes.
369 369  
370 -=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
371 371  
372 372  {{code}}
373 373  {{info}}
... ... @@ -375,19 +375,20 @@
375 375  {{/info}}
376 376  {{/code}}
377 377  
200 +
201 +1. **Warning Macro**: Highlights warnings or important notices.
378 378  
379 -== Footnote Macro ==
380 380  
381 -The Footnote macro adds footnotes to the page.
204 +{{code}}
205 +{{warning}}
206 +Caution: Proceed with care.
207 +{{/warning}}
208 +{{/code}}
382 382  
383 -{{example}}
384 -This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
385 -{{putFootnotes/}}
386 -{{/example}}
210 +
211 +1. **Code Macro**: Renders code snippets with syntax highlighting.
387 387  
388 388  
389 -=== **Code Macro**: Renders code snippets with syntax highlighting. ===
390 -
391 391  {{code}}
392 392  {{code language="python"}}
393 393  def hello_world():
... ... @@ -395,8 +395,9 @@
395 395  {{/code}}
396 396  {{/code}}
397 397  
221 +
222 +1. **Gallery Macro**: Creates an image gallery from attached images.
398 398  
399 -=== **Gallery Macro**: Creates an image gallery from attached images. ===
400 400  
401 401  {{code}}
402 402  {{gallery}}
... ... @@ -405,98 +405,40 @@
405 405  {{/gallery}}
406 406  {{/code}}
407 407  
232 +
233 +1. **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings.
408 408  
409 -=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
410 410  
411 411  {{code}}
412 412  {{toc/}}
413 413  {{/code}}
414 414  
415 -== Video Macro ==
240 +
241 +1. **Include Macro**: Embeds content from another page.
416 416  
417 -The Video macro embeds videos.
418 418  
419 -{{example}}
420 -{{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
421 -{{/example}}
244 +{{code}}
245 +{{include reference="PageName"/}}
246 +{{/code}}
422 422  
248 +
249 +1. **Display Macro**: Displays the content of another document or an object property.
423 423  
424 -== Example Macro ==
425 425  
426 -The example macro displays the output of a macro or script or anything that you like
427 -== Expandable Macro ==
252 +{{code}}
253 +{{display reference="PageName"/}}
254 +{{/code}}
428 428  
429 -The following example demonstrates how to present complex information cleanly using `
256 +
257 +1. **Velocity Macro**: Executes Velocity scripts for dynamic content generation.
430 430  
431 -{{example}}
432 432  
433 -{{expandable summary="Study: The Wilson Effect: The Increase in Heritability of IQ With Age"}}
434 -**Source:** *Twin Research and Human Genetics (Cambridge University Press)*
435 -**Date of Publication:** *2013*
436 -**Author(s):** *Thomas J. Bouchard Jr.*
437 -**Title:** *"The Wilson Effect: The Increase in Heritability of IQ With Age"*
438 -**DOI:** [10.1017/thg.2013.54](https://doi.org/10.1017/thg.2013.54)
439 -**Subject Matter:** *Intelligence, Heritability, Developmental Psychology*
260 +{{code}}
261 +{{velocity}}
262 +#set($greeting = "Hello, $user.name!")
263 +$greeting
264 +{{/velocity}}
265 +{{/code}}
440 440  
441 -{{expandable summary="📊 Key Statistics"}}
442 -1. **General Observations:**
443 - - The study documents how the **heritability of IQ increases with age**, reaching an asymptote at **0.80 by adulthood**.
444 - - Analysis is based on **longitudinal twin and adoption studies**.
445 -
446 -2. **Subgroup Analysis:**
447 - - Shared environmental influence on IQ **declines with age**, reaching **0.10 in adulthood**.
448 - - Monozygotic twins show **increasing genetic similarity in IQ over time**, while dizygotic twins become **less concordant**.
449 -
450 -3. **Other Significant Data Points:**
451 - - Data from the **Louisville Longitudinal Twin Study and cross-national twin samples** support findings.
452 - - IQ stability over time is **influenced more by genetics than by shared environmental factors**.
453 -{{/expandable}}
454 -
455 -{{expandable summary="🔬 Findings"}}
456 -1. **Primary Observations:**
457 - - Intelligence heritability **strengthens throughout development**, contrary to early environmental models.
458 - - Shared environmental effects **decrease by late adolescence**, emphasizing **genetic influence in adulthood**.
459 -
460 -2. **Subgroup Trends:**
461 - - Studies from **Scotland, Netherlands, and the US** show **consistent patterns of increasing heritability with age**.
462 - - Findings hold across **varied socio-economic and educational backgrounds**.
463 -
464 -3. **Specific Case Analysis:**
465 - - Longitudinal adoption studies show **declining impact of adoptive parental influence on IQ** as children age.
466 - - Cross-sectional twin data confirm **higher IQ correlations for monozygotic twins in adulthood**.
467 -{{/expandable}}
468 -
469 -{{expandable summary="📝 Critique & Observations"}}
470 -1. **Strengths of the Study:**
471 - - **Robust dataset covering multiple twin and adoption studies over decades**.
472 - - **Clear, replicable trend** demonstrating the increasing role of genetics in intelligence.
473 -
474 -2. **Limitations of the Study:**
475 - - Findings apply primarily to **Western industrialized nations**, limiting generalizability.
476 - - **Lack of neurobiological mechanisms** explaining how genes express their influence over time.
477 -
478 -3. **Suggestions for Improvement:**
479 - - Future research should investigate **gene-environment interactions in cognitive aging**.
480 - - Examine **heritability trends in non-Western populations** to determine cross-cultural consistency.
481 -{{/expandable}}
482 -
483 -{{expandable summary="📌 Relevance to Subproject"}}
484 -- Provides **strong evidence for the genetic basis of intelligence**.
485 -- Highlights the **diminishing role of shared environment in cognitive development**.
486 -- Supports research on **cognitive aging and heritability across the lifespan**.
487 -{{/expandable}}
488 -
489 -{{expandable summary="🔍 Suggestions for Further Exploration"}}
490 -1. Investigate **neurogenetic pathways underlying IQ development**.
491 -2. Examine **how education and socioeconomic factors interact with genetic IQ influences**.
492 -3. Study **heritability trends in aging populations and cognitive decline**.
493 -{{/expandable}}
494 -
495 -{{expandable summary="📄 Download Full Study"}}
496 -[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
497 -{{/expandable}}
498 -{{/expandable}}
499 -{{/example}}
500 -
501 -
502 -
267 +
268 +1. **HTML Macro**: Allows the inclusion of