... |
... |
@@ -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,174 +10,6 @@ |
10 |
10 |
|
11 |
11 |
---- |
12 |
12 |
|
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 |
|
- |
181 |
181 |
== ๐ **Attachments and Images** == |
182 |
182 |
|
183 |
183 |
You can easily upload files and images directly from the WYSIWYG editor: |
... |
... |
@@ -258,6 +258,10 @@ |
258 |
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 |
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.๎ |
260 |
260 |
|
|
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 |
+ |
261 |
261 |
== **Essential Formatting Options** == |
262 |
262 |
|
263 |
263 |
To ensure content is both engaging and accessible, utilize the following formatting techniques:๎ |
... |
... |
@@ -275,7 +275,6 @@ |
275 |
275 |
|
276 |
276 |
|
277 |
277 |
|
278 |
|
-* |
279 |
279 |
** ((( |
280 |
280 |
=== **Bold**: Surround text with double asterisks. === |
281 |
281 |
))) |
... |
... |
@@ -285,7 +285,6 @@ |
285 |
285 |
{{/code}} |
286 |
286 |
|
287 |
287 |
|
288 |
|
-* |
289 |
289 |
** ((( |
290 |
290 |
=== **Italics**: Use double underscores. === |
291 |
291 |
))) |
... |
... |
@@ -295,7 +295,6 @@ |
295 |
295 |
{{/code}} |
296 |
296 |
|
297 |
297 |
|
298 |
|
-* |
299 |
299 |
** ((( |
300 |
300 |
=== **Underline**: Enclose text with double tildes. === |
301 |
301 |
))) |
... |
... |
@@ -305,7 +305,6 @@ |
305 |
305 |
{{/code}} |
306 |
306 |
|
307 |
307 |
|
308 |
|
-* |
309 |
309 |
** ((( |
310 |
310 |
=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). === |
311 |
311 |
))) |
... |
... |
@@ -316,7 +316,6 @@ |
316 |
316 |
{{/code}} |
317 |
317 |
|
318 |
318 |
|
319 |
|
-* |
320 |
320 |
** ((( |
321 |
321 |
=== **Ordered List**: Start lines with a number followed by a period. === |
322 |
322 |
))) |
... |
... |
@@ -329,8 +329,6 @@ |
329 |
329 |
|
330 |
330 |
== **Links** == |
331 |
331 |
|
332 |
|
- |
333 |
|
- |
334 |
334 |
==== **Internal Link**: Use square brackets with the page name. ==== |
335 |
335 |
|
336 |
336 |
{{code}} |
... |
... |
@@ -337,15 +337,16 @@ |
337 |
337 |
[[PageName]] |
338 |
338 |
{{/code}} |
339 |
339 |
|
340 |
|
- |
341 |
|
- |
|
171 |
+* |
|
172 |
+** ((( |
342 |
342 |
==== **External Link**: Provide the URL directly. ==== |
|
174 |
+))) |
343 |
343 |
|
344 |
344 |
{{code}} |
345 |
345 |
[https://www.example.com] |
346 |
346 |
{{/code}} |
347 |
347 |
|
348 |
|
-((( |
|
180 |
+* ((( |
349 |
349 |
=== **Images** === |
350 |
350 |
))) |
351 |
351 |
|
... |
... |
@@ -358,15 +358,15 @@ |
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 == |
|
193 |
+**Box Macro**: Encapsulates content within a styled box, useful for highlighting information. |
362 |
362 |
|
363 |
|
-The Embed macro shows external content like YouTube videos. |
|
195 |
+{{code}} |
|
196 |
+{{box}} |
|
197 |
+Your content here. |
|
198 |
+{{/box}} |
|
199 |
+{{/code}} |
364 |
364 |
|
365 |
|
-{{example}} |
366 |
|
-{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}} |
367 |
|
-{{/example}} |
368 |
368 |
|
369 |
|
- |
370 |
370 |
=== **Info Macro**: Displays an informational message, often used for tips or notes. === |
371 |
371 |
|
372 |
372 |
{{code}} |
... |
... |
@@ -376,16 +376,15 @@ |
376 |
376 |
{{/code}} |
377 |
377 |
|
378 |
378 |
|
379 |
|
-== Footnote Macro == |
|
211 |
+=== **Warning Macro**: Highlights warnings or important notices. === |
380 |
380 |
|
381 |
|
-The Footnote macro adds footnotes to the page. |
|
213 |
+{{code}} |
|
214 |
+{{warning}} |
|
215 |
+Caution: Proceed with care. |
|
216 |
+{{/warning}} |
|
217 |
+{{/code}} |
382 |
382 |
|
383 |
|
-{{example}} |
384 |
|
-This is a statement{{footnote}}Source: Example Reference{{/footnote}}. |
385 |
|
-{{putFootnotes/}} |
386 |
|
-{{/example}} |
387 |
387 |
|
388 |
|
- |
389 |
389 |
=== **Code Macro**: Renders code snippets with syntax highlighting. === |
390 |
390 |
|
391 |
391 |
{{code}} |
... |
... |
@@ -412,91 +412,28 @@ |
412 |
412 |
{{toc/}} |
413 |
413 |
{{/code}} |
414 |
414 |
|
415 |
|
-== Video Macro == |
416 |
416 |
|
417 |
|
-The Video macro embeds videos. |
|
247 |
+=== **Include Macro**: Embeds content from another page. === |
418 |
418 |
|
419 |
|
-{{example}} |
420 |
|
-{{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}} |
421 |
|
-{{/example}} |
|
249 |
+{{code}} |
|
250 |
+{{include reference="PageName"/}} |
|
251 |
+{{/code}} |
422 |
422 |
|
423 |
423 |
|
424 |
|
-== Example Macro == |
|
254 |
+=== **Display Macro**: Displays the content of another document or an object property. === |
425 |
425 |
|
426 |
|
-The example macro displays the output of a macro or script or anything that you like |
427 |
|
-== Expandable Macro == |
|
256 |
+{{code}} |
|
257 |
+{{display reference="PageName"/}} |
|
258 |
+{{/code}} |
428 |
428 |
|
429 |
|
-The following example demonstrates how to present complex information cleanly using ` |
430 |
430 |
|
431 |
|
-{{example}} |
|
261 |
+=== **Velocity Macro**: Executes Velocity scripts for dynamic content generation. === |
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* |
|
263 |
+{{code}} |
|
264 |
+{{velocity}} |
|
265 |
+#set($greeting = "Hello, $user.name!") |
|
266 |
+$greeting |
|
267 |
+{{/velocity}} |
|
268 |
+{{/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 |
|
- |
|
270 |
+ |