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 7.1
edited by Ryan C
on 2025/03/16 01:16
Change comment: There is no comment for this version
To version 22.1
edited by Ryan C
on 2025/05/14 13:41
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,20 +2,182 @@
2 2  
3 3  ----
4 4  
5 -== Getting Started with XWiki ==
5 +== ==
6 6  
7 -This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
8 -
9 9  == 📖 Table of Contents: ==
10 10  
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]]
9 +{{toc/}}
16 16  
17 17  ----
18 18  
13 +== Getting Started with XWiki ==
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 +
19 19  == 📎 **Attachments and Images** ==
20 20  
21 21  You can easily upload files and images directly from the WYSIWYG editor:
... ... @@ -52,7 +52,7 @@
52 52  
53 53  ----
54 54  
55 -== ✏️** Basic Formatting and Links (Quick Guide)** ==
217 +== ✏️** 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.
... ... @@ -96,10 +96,6 @@
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  
99 -=== **Switching Between Syntaxes** ===
100 -
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 103  == **Essential Formatting Options** ==
104 104  
105 105  To ensure content is both engaging and accessible, utilize the following formatting techniques:
... ... @@ -116,6 +116,7 @@
116 116  === **Text Formatting** ===
117 117  
118 118  
277 +
119 119  *
120 120  ** (((
121 121  === **Bold**: Surround text with double asterisks. ===
... ... @@ -125,6 +125,7 @@
125 125  **bold text**
126 126  {{/code}}
127 127  
287 +
128 128  *
129 129  ** (((
130 130  === **Italics**: Use double underscores. ===
... ... @@ -134,6 +134,7 @@
134 134  __italic text__
135 135  {{/code}}
136 136  
297 +
137 137  *
138 138  ** (((
139 139  === **Underline**: Enclose text with double tildes. ===
... ... @@ -143,8 +143,6 @@
143 143  ~~underlined text~~
144 144  {{/code}}
145 145  
146 -*
147 -*
148 148  
149 149  *
150 150  ** (((
... ... @@ -156,6 +156,7 @@
156 156  * Item 2
157 157  {{/code}}
158 158  
318 +
159 159  *
160 160  ** (((
161 161  === **Ordered List**: Start lines with a number followed by a period. ===
... ... @@ -166,15 +166,11 @@
166 166  2. Second item
167 167  {{/code}}
168 168  
169 -* (((
170 -=== ===
171 -)))
172 -* (((
173 -=== **Links** ===
174 -)))
175 175  
330 +== **Links** ==
176 176  
177 177  
333 +
178 178  ==== **Internal Link**: Use square brackets with the page name. ====
179 179  
180 180  {{code}}
... ... @@ -181,16 +181,15 @@
181 181  [[PageName]]
182 182  {{/code}}
183 183  
184 -*
185 -** (((
340 +
341 +
186 186  ==== **External Link**: Provide the URL directly. ====
187 -)))
188 188  
189 189  {{code}}
190 190  [https://www.example.com]
191 191  {{/code}}
192 192  
193 -* (((
348 +(((
194 194  === **Images** ===
195 195  )))
196 196  
... ... @@ -203,17 +203,17 @@
203 203  
204 204  Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
205 205  
206 -1. **Box Macro**: Encapsulates content within a styled box, useful for highlighting information.
361 +== Embed Macro ==
207 207  
208 -{{code}}
209 -{{box}}
210 -Your content here.
211 -{{/box}}
212 -{{/code}}
363 +The Embed macro shows external content like YouTube videos.
213 213  
365 +{{example}}
366 +{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
367 +{{/example}}
214 214  
215 -=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
216 216  
370 +=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
371 +
217 217  {{code}}
218 218  {{info}}
219 219  This is an informational note.
... ... @@ -221,17 +221,18 @@
221 221  {{/code}}
222 222  
223 223  
224 -=== **Warning Macro**: Highlights warnings or important notices. ===
379 +== Footnote Macro ==
225 225  
226 -{{code}}
227 -{{warning}}
228 -Caution: Proceed with care.
229 -{{/warning}}
230 -{{/code}}
381 +The Footnote macro adds footnotes to the page.
231 231  
383 +{{example}}
384 +This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
385 +{{putFootnotes/}}
386 +{{/example}}
232 232  
233 -=== **Code Macro**: Renders code snippets with syntax highlighting. ===
234 234  
389 +=== **Code Macro**: Renders code snippets with syntax highlighting. ===
390 +
235 235  {{code}}
236 236  {{code language="python"}}
237 237  def hello_world():
... ... @@ -240,7 +240,7 @@
240 240  {{/code}}
241 241  
242 242  
243 -=== **Gallery Macro**: Creates an image gallery from attached images. ===
399 +=== **Gallery Macro**: Creates an image gallery from attached images. ===
244 244  
245 245  {{code}}
246 246  {{gallery}}
... ... @@ -256,28 +256,91 @@
256 256  {{toc/}}
257 257  {{/code}}
258 258  
415 +== Video Macro ==
259 259  
260 -=== **Include Macro**: Embeds content from another page. ===
417 +The Video macro embeds videos.
261 261  
262 -{{code}}
263 -{{include reference="PageName"/}}
264 -{{/code}}
419 +{{example}}
420 +{{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
421 +{{/example}}
265 265  
266 266  
267 -=== **Display Macro**: Displays the content of another document or an object property. ===
424 +== Example Macro ==
268 268  
269 -{{code}}
270 -{{display reference="PageName"/}}
271 -{{/code}}
426 +The example macro displays the output of a macro or script or anything that you like
427 +== Expandable Macro ==
272 272  
429 +The following example demonstrates how to present complex information cleanly using `
273 273  
274 -=== **Velocity Macro**: Executes Velocity scripts for dynamic content generation. ===
431 +{{example}}
275 275  
276 -{{code}}
277 -{{velocity}}
278 -#set($greeting = "Hello, $user.name!")
279 -$greeting
280 -{{/velocity}}
281 -{{/code}}
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*
282 282  
283 -
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 +