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 8.1
edited by Ryan C
on 2025/03/16 01:18
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,10 +2,8 @@
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 11  {{toc/}}
... ... @@ -12,6 +12,174 @@
12 12  
13 13  ----
14 14  
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 +
15 15  == πŸ“Ž **Attachments and Images** ==
16 16  
17 17  You can easily upload files and images directly from the WYSIWYG editor:
... ... @@ -92,10 +92,6 @@
92 92  * **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.ξˆ†
93 93  * **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.ξˆ†
94 94  
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,6 +112,7 @@
112 112  === **Text Formatting** ===
113 113  
114 114  
277 +
115 115  *
116 116  ** (((
117 117  === **Bold**: Surround text with double asterisks. ===
... ... @@ -121,6 +121,7 @@
121 121  **bold text**
122 122  {{/code}}
123 123  
287 +
124 124  *
125 125  ** (((
126 126  === **Italics**: Use double underscores. ===
... ... @@ -130,6 +130,7 @@
130 130  __italic text__
131 131  {{/code}}
132 132  
297 +
133 133  *
134 134  ** (((
135 135  === **Underline**: Enclose text with double tildes. ===
... ... @@ -139,8 +139,6 @@
139 139  ~~underlined text~~
140 140  {{/code}}
141 141  
142 -*
143 -*
144 144  
145 145  *
146 146  ** (((
... ... @@ -152,6 +152,7 @@
152 152  * Item 2
153 153  {{/code}}
154 154  
318 +
155 155  *
156 156  ** (((
157 157  === **Ordered List**: Start lines with a number followed by a period. ===
... ... @@ -162,15 +162,11 @@
162 162  2. Second item
163 163  {{/code}}
164 164  
165 -* (((
166 -=== ===
167 -)))
168 -* (((
169 -=== **Links** ===
170 -)))
171 171  
330 +== **Links** ==
172 172  
173 173  
333 +
174 174  ==== **Internal Link**: Use square brackets with the page name. ====
175 175  
176 176  {{code}}
... ... @@ -177,16 +177,15 @@
177 177  [[PageName]]
178 178  {{/code}}
179 179  
180 -*
181 -** (((
340 +
341 +
182 182  ==== **External Link**: Provide the URL directly. ====
183 -)))
184 184  
185 185  {{code}}
186 186  [https://www.example.com]
187 187  {{/code}}
188 188  
189 -* (((
348 +(((
190 190  === **Images** ===
191 191  )))
192 192  
... ... @@ -199,17 +199,17 @@
199 199  
200 200  Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:ξˆ†
201 201  
202 -1. **Box Macro**: Encapsulates content within a styled box, useful for highlighting information.ξˆ†
361 +== Embed Macro ==
203 203  
204 -{{code}}
205 -{{box}}
206 -Your content here.
207 -{{/box}}
208 -{{/code}}
363 +The Embed macro shows external content like YouTube videos.
209 209  
365 +{{example}}
366 +{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
367 +{{/example}}
210 210  
211 -=== **Info Macro**: Displays an informational message, often used for tips or notes.ξˆ† ===
212 212  
370 +=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
371 +
213 213  {{code}}
214 214  {{info}}
215 215  This is an informational note.
... ... @@ -217,17 +217,18 @@
217 217  {{/code}}
218 218  
219 219  
220 -=== **Warning Macro**: Highlights warnings or important notices.ξˆ† ===
379 +== Footnote Macro ==
221 221  
222 -{{code}}
223 -{{warning}}
224 -Caution: Proceed with care.
225 -{{/warning}}
226 -{{/code}}
381 +The Footnote macro adds footnotes to the page.
227 227  
383 +{{example}}
384 +This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
385 +{{putFootnotes/}}
386 +{{/example}}
228 228  
229 -=== **Code Macro**: Renders code snippets with syntax highlighting.ξˆ† ===
230 230  
389 +=== **Code Macro**: Renders code snippets with syntax highlighting. ===
390 +
231 231  {{code}}
232 232  {{code language="python"}}
233 233  def hello_world():
... ... @@ -236,7 +236,7 @@
236 236  {{/code}}
237 237  
238 238  
239 -=== **Gallery Macro**: Creates an image gallery from attached images.ξˆ† ===
399 +=== **Gallery Macro**: Creates an image gallery from attached images. ===
240 240  
241 241  {{code}}
242 242  {{gallery}}
... ... @@ -252,28 +252,91 @@
252 252  {{toc/}}
253 253  {{/code}}
254 254  
415 +== Video Macro ==
255 255  
256 -=== **Include Macro**: Embeds content from another page. ===
417 +The Video macro embeds videos.
257 257  
258 -{{code}}
259 -{{include reference="PageName"/}}
260 -{{/code}}
419 +{{example}}
420 +{{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
421 +{{/example}}
261 261  
262 262  
263 -=== **Display Macro**: Displays the content of another document or an object property. ===
424 +== Example Macro ==
264 264  
265 -{{code}}
266 -{{display reference="PageName"/}}
267 -{{/code}}
426 +The example macro displays the output of a macro or script or anything that you like
427 +== Expandable Macro ==
268 268  
429 +The following example demonstrates how to present complex information cleanly using `
269 269  
270 -=== **Velocity Macro**: Executes Velocity scripts for dynamic content generation. ===
431 +{{example}}
271 271  
272 -{{code}}
273 -{{velocity}}
274 -#set($greeting = "Hello, $user.name!")
275 -$greeting
276 -{{/velocity}}
277 -{{/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*
278 278  
279 -
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 +