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 28.1
edited by Ryan C
on 2025/05/14 15:42
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -12,9 +12,116 @@
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 +{{example}}
67 +footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}}
68 +
69 +{{putFootnotes/}}
70 +{{/example}}
71 +
72 +
73 +== Groovy Lookup ==
74 +
75 +{{example}}
76 +{{groovy}}
77 +def now = new Date()
78 +println("Current time: " + now)
79 +{{/groovy}}
80 +{{/example}}
81 +
82 +
83 +== Expandable Summary ==
84 +
85 +{{example}}
86 +{{expandable summary="🧠 Study Summary"}}
87 +Key findings go here.
88 +{{/expandable}}
89 +{{/example}}
90 +
91 +== List Formatting ==
92 +
93 +{{example}}
94 +*Bad formatting*
95 +
96 +* use - inconsistently
97 +** Good formatting:
98 +* Consistent bullet style
99 +* Indented items properly
100 +{{/example}}
101 +
102 +== Python Code ==
103 +
104 +{{example}}
105 +{{code language="python"}}
106 +def greet():
107 + print("Hello World")
108 +{{/code}}
109 +{{/example}}
110 +
111 +== Audio Embedding ==
112 +
113 +{{example}}
114 +{{html}}
115 +<audio controls>
116 + <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
117 + Your browser does not support the audio element.
118 +</audio>
119 +{{/html}}
120 +{{/example}}
121 +
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 -== ==
124 +== ==
18 18  
19 19  == 📎 **Attachments and Images** ==
20 20  
... ... @@ -33,6 +33,8 @@
33 33  1. Upload or select the image.
34 34  1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
35 35  
143 +[[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]]
144 +
36 36  ----
37 37  
38 38  == ⚡ **Using the / Macro Shortcut** ==
... ... @@ -258,12 +258,16 @@
258 258  {{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
259 259  {{/example}}
260 260  
370 +
371 +== Example Macro ==
372 +
373 +The example macro displays the output of a macro or script or anything that you like
374 +
261 261  == Expandable Macro ==
262 -The following example demonstrates how to present complex information cleanly using `{{expandable}}` and `{{example}}`.
263 263  
377 +The following example demonstrates how to present complex information cleanly using `
378 +
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}}
446 +{{/example}}
333 333  
334 334  
335 -== See Also: ==
336 -
337 -[[Syntax Help official documentation for a full list of formatting options>>doc:XWiki.XWikiSyntax]]
449 +
1747262485678-297.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.AdminAngriff
Size
... ... @@ -1,0 +1,1 @@
1 +1.6 MB
Content