... |
... |
@@ -12,6 +12,168 @@ |
12 |
12 |
|
13 |
13 |
== Getting Started with XWiki == |
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 |
+ |
15 |
15 |
This page covers all the essential steps and tips you need to create great content in XWiki without any confusion. |
16 |
16 |
|
17 |
17 |
== == |
... |
... |
@@ -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:ξ |
... |
... |
@@ -200,15 +200,15 @@ |
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. |
|
361 |
+== Embed Macro == |
204 |
204 |
|
205 |
|
-{{code}} |
206 |
|
-{{box}} |
207 |
|
-Your content here. |
208 |
|
-{{/box}} |
209 |
|
-{{/code}} |
|
363 |
+The Embed macro shows external content like YouTube videos. |
210 |
210 |
|
|
365 |
+{{example}} |
|
366 |
+{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}} |
|
367 |
+{{/example}} |
211 |
211 |
|
|
369 |
+ |
212 |
212 |
=== **Info Macro**: Displays an informational message, often used for tips or notes. === |
213 |
213 |
|
214 |
214 |
{{code}} |
... |
... |
@@ -218,15 +218,16 @@ |
218 |
218 |
{{/code}} |
219 |
219 |
|
220 |
220 |
|
221 |
|
-=== **Warning Macro**: Highlights warnings or important notices. === |
|
379 |
+== Footnote Macro == |
222 |
222 |
|
223 |
|
-{{code}} |
224 |
|
-{{warning}} |
225 |
|
-Caution: Proceed with care. |
226 |
|
-{{/warning}} |
227 |
|
-{{/code}} |
|
381 |
+The Footnote macro adds footnotes to the page. |
228 |
228 |
|
|
383 |
+{{example}} |
|
384 |
+This is a statement{{footnote}}Source: Example Reference{{/footnote}}. |
|
385 |
+{{putFootnotes/}} |
|
386 |
+{{/example}} |
229 |
229 |
|
|
388 |
+ |
230 |
230 |
=== **Code Macro**: Renders code snippets with syntax highlighting. === |
231 |
231 |
|
232 |
232 |
{{code}} |
... |
... |
@@ -253,30 +253,91 @@ |
253 |
253 |
{{toc/}} |
254 |
254 |
{{/code}} |
255 |
255 |
|
|
415 |
+== Video Macro == |
256 |
256 |
|
257 |
|
-=== **Include Macro**: Embeds content from another page. === |
|
417 |
+The Video macro embeds videos. |
258 |
258 |
|
259 |
|
-{{code}} |
260 |
|
-{{include reference="PageName"/}} |
261 |
|
-{{/code}} |
|
419 |
+{{example}} |
|
420 |
+{{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}} |
|
421 |
+{{/example}} |
262 |
262 |
|
263 |
263 |
|
264 |
|
-=== **Display Macro**: Displays the content of another document or an object property. === |
|
424 |
+== Example Macro == |
265 |
265 |
|
266 |
|
-{{code}} |
267 |
|
-{{display reference="PageName"/}} |
268 |
|
-{{/code}} |
|
426 |
+The example macro displays the output of a macro or script or anything that you like |
|
427 |
+== Expandable Macro == |
269 |
269 |
|
|
429 |
+The following example demonstrates how to present complex information cleanly using ` |
270 |
270 |
|
271 |
|
-=== **Velocity Macro**: Executes Velocity scripts for dynamic content generation. === |
|
431 |
+{{example}} |
272 |
272 |
|
273 |
|
-{{code}} |
274 |
|
-{{velocity}} |
275 |
|
-#set($greeting = "Hello, $user.name!") |
276 |
|
-$greeting |
277 |
|
-{{/velocity}} |
278 |
|
-{{/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* |
279 |
279 |
|
280 |
|
-== See Also: == |
|
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**. |
281 |
281 |
|
282 |
|
-[[Syntax Help official documentation for a full list of formatting options>>doc:XWiki.XWikiSyntax]] |
|
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 |
+ |