0 Votes

Changes for page Start here if you're new

Last modified by Ryan C on 2025/06/28 04:59

From version 23.1
edited by Ryan C
on 2025/05/14 15:33
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
... ... @@ -12,7 +12,7 @@
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**:
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 16  
17 17  ---
18 18  
... ... @@ -20,19 +20,25 @@
20 20  
21 21  Show how a macro works without cluttering the page with raw syntax.
22 22  
23 -
23 +```xwiki
24 24  == Gallery Macro ==
25 -
26 26  {{example}}
27 -
28 28  {{gallery}}
29 29  [[image:photo1.jpg]]
30 30  [[image:photo2.jpg]]
31 31  {{/gallery}}
32 -
33 33  {{/example}}
31 +```
34 34  
33 +**Why it's good:** New users see both source and result without confusion.
35 35  
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
36 36  == Boilerplate Box ==
37 37  {{example}}
38 38  {{box cssClass="highlight"}}
... ... @@ -39,7 +39,15 @@
39 39  Insert your highlighted content here.
40 40  {{/box}}
41 41  {{/example}}
48 +```
42 42  
50 +---
51 +
52 +## 🎓 3. **Educational Tutorials (e.g., Velocity or Groovy)**
53 +
54 +Teach scripting with real, live code examples.
55 +
56 +```xwiki
43 43  == Velocity Greeting ==
44 44  {{example}}
45 45  {{velocity}}
... ... @@ -47,8 +47,15 @@
47 47  Hello, $name!
48 48  {{/velocity}}
49 49  {{/example}}
64 +```
50 50  
66 +---
51 51  
68 +## 🎯 4. **Comparing Macro Parameters**
69 +
70 +Demonstrate how different macro parameters change output—side-by-side.
71 +
72 +```xwiki
52 52  == Info vs Warning ==
53 53  {{example}}
54 54  {{info}}This is an info box.{{/info}}
... ... @@ -55,13 +55,29 @@
55 55  
56 56  {{warning}}This is a warning box.{{/warning}}
57 57  {{/example}}
79 +```
58 58  
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
59 59  == Footnote Demo ==
60 60  {{example}}
61 61  This claim needs a source{{footnote}}Here it is.{{/footnote}}.
62 62  {{putFootnotes/}}
63 63  {{/example}}
93 +```
64 64  
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
65 65  == Groovy Lookup ==
66 66  {{example}}
67 67  {{groovy}}
... ... @@ -69,8 +69,15 @@
69 69  println("Current time: " + now)
70 70  {{/groovy}}
71 71  {{/example}}
109 +```
72 72  
111 +---
73 73  
113 +## 📦 7. **Component/API Call Demos**
114 +
115 +Useful for devs exploring the API.
116 +
117 +```xwiki
74 74  == Access Current User ==
75 75  {{example}}
76 76  {{velocity}}
... ... @@ -77,8 +77,15 @@
77 77  Current user: **$xcontext.user**
78 78  {{/velocity}}
79 79  {{/example}}
124 +```
80 80  
126 +---
81 81  
128 +## 📘 8. **Expandable Wiki Templates with Output**
129 +
130 +Pair `{{example}}` with `{{expandable}}` for full disclosure without visual clutter.
131 +
132 +```xwiki
82 82  == Expandable Summary ==
83 83  {{example}}
84 84  {{expandable summary="🧠 Study Summary"}}
... ... @@ -85,7 +85,15 @@
85 85  Key findings go here.
86 86  {{/expandable}}
87 87  {{/example}}
139 +```
88 88  
141 +---
142 +
143 +## 🔧 9. **Syntax Training: Bad vs Good**
144 +
145 +Side-by-side "Do this, not that" with toggles.
146 +
147 +```xwiki
89 89  == List Formatting ==
90 90  {{example}}
91 91  *Bad formatting*
... ... @@ -94,7 +94,13 @@
94 94   * Consistent bullet style
95 95   * Indented items properly
96 96  {{/example}}
156 +```
97 97  
158 +---
159 +
160 +## 💡 Bonus Tip: Combine `{{example}}` + `{{code}}` for Highlighted Snippets
161 +
162 +```xwiki
98 98  == Python Code ==
99 99  {{example}}
100 100  {{code language="python"}}
... ... @@ -102,17 +102,13 @@
102 102   print("Hello World")
103 103  {{/code}}
104 104  {{/example}}
170 +```
105 105  
106 -== Audio Embedding ==
107 -{{example}}
108 -{{html}}
109 -<audio controls>
110 - <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
111 - Your browser does not support the audio element.
112 -</audio>
113 -{{/html}}
114 -{{/example}}
115 -
172 +---
173 +
174 +Want me to generate a panel with these uses or make a macro gallery page pre-filled with them?
175 +
176 +
116 116  This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
117 117  
118 118  == ==

XWiki AI Chat