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 17.1
edited by Ryan C
on 2025/05/14 13:33
Change comment: There is no comment for this version
To version 26.1
edited by Ryan C
on 2025/05/14 15:38
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -12,9 +12,114 @@
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 +
24 +== Gallery Macro ==
25 +
26 +{{example}}
27 +{{gallery}}
28 +[[image:photo1.jpg]]
29 +[[image:photo2.jpg]]
30 +{{/gallery}}
31 +{{/example}}
32 +
33 +
34 +== Boilerplate Box ==
35 +
36 +{{example}}
37 +{{box cssClass="highlight"}}
38 +Insert your highlighted content here.
39 +{{/box}}
40 +{{/example}}
41 +
42 +== Velocity Greeting ==
43 +
44 +{{example}}
45 +{{velocity}}
46 +#set($name = "Visitor")
47 +Hello, $name!
48 +{{/velocity}}
49 +{{/example}}
50 +
51 +
52 +== Info vs Warning ==
53 +
54 +{{example}}
55 +{{info}}
56 +This is an info box.
57 +{{/info}}
58 +
59 +{{warning}}
60 +This is a warning box.
61 +{{/warning}}
62 +{{/example}}
63 +
64 +== Footnote Demo ==
65 +
66 +footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}}
67 +
68 +{{putFootnotes/}}
69 +
70 +
71 +== Groovy Lookup ==
72 +
73 +{{example}}
74 +{{groovy}}
75 +def now = new Date()
76 +println("Current time: " + now)
77 +{{/groovy}}
78 +{{/example}}
79 +
80 +
81 +== Expandable Summary ==
82 +
83 +{{example}}
84 +{{expandable summary="🧠 Study Summary"}}
85 +Key findings go here.
86 +{{/expandable}}
87 +{{/example}}
88 +
89 +== List Formatting ==
90 +
91 +{{example}}
92 +*Bad formatting*
93 +
94 +* use - inconsistently
95 +** Good formatting:
96 +* Consistent bullet style
97 +* Indented items properly
98 +{{/example}}
99 +
100 +== Python Code ==
101 +
102 +{{example}}
103 +{{code language="python"}}
104 +def greet():
105 + print("Hello World")
106 +{{/code}}
107 +{{/example}}
108 +
109 +== Audio Embedding ==
110 +
111 +{{example}}
112 +{{html}}
113 +<audio controls>
114 + <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
115 + Your browser does not support the audio element.
116 +</audio>
117 +{{/html}}
118 +{{/example}}
119 +
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 -== ==
122 +== ==
18 18  
19 19  == 📎 **Attachments and Images** ==
20 20  
... ... @@ -113,7 +113,7 @@
113 113  
114 114  
115 115  
116 -*
221 +*
117 117  ** (((
118 118  === **Bold**: Surround text with double asterisks. ===
119 119  )))
... ... @@ -123,7 +123,7 @@
123 123  {{/code}}
124 124  
125 125  
126 -*
231 +*
127 127  ** (((
128 128  === **Italics**: Use double underscores. ===
129 129  )))
... ... @@ -133,7 +133,7 @@
133 133  {{/code}}
134 134  
135 135  
136 -*
241 +*
137 137  ** (((
138 138  === **Underline**: Enclose text with double tildes. ===
139 139  )))
... ... @@ -143,7 +143,7 @@
143 143  {{/code}}
144 144  
145 145  
146 -*
251 +*
147 147  ** (((
148 148  === **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
149 149  )))
... ... @@ -154,7 +154,7 @@
154 154  {{/code}}
155 155  
156 156  
157 -*
262 +*
158 158  ** (((
159 159  === **Ordered List**: Start lines with a number followed by a period. ===
160 160  )))
... ... @@ -258,12 +258,16 @@
258 258  {{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
259 259  {{/example}}
260 260  
366 +
367 +== Example Macro ==
368 +
369 +The example macro displays the output of a macro or script or anything that you like
370 +
261 261  == Expandable Macro ==
262 -The following example demonstrates how to present complex information cleanly using `{{expandable}}` and `{{example}}`.
263 263  
373 +The following example demonstrates how to present complex information cleanly using `
374 +
264 264  {{example}}
265 -
266 -
267 267  {{expandable summary="Study: The Wilson Effect: The Increase in Heritability of IQ With Age"}}
268 268  **Source:** *Twin Research and Human Genetics (Cambridge University Press)*
269 269  **Date of Publication:** *2013*
... ... @@ -330,8 +330,7 @@
330 330  [[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
331 331  {{/expandable}}
332 332  {{/expandable}}
442 +{{/example}}
333 333  
334 334  
335 -== See Also: ==
336 -
337 -[[Syntax Help official documentation for a full list of formatting options>>doc:XWiki.XWikiSyntax]]
445 +