... |
... |
@@ -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,25 +20,19 @@ |
20 |
20 |
|
21 |
21 |
Show how a macro works without cluttering the page with raw syntax. |
22 |
22 |
|
23 |
|
-```xwiki |
|
23 |
+ |
24 |
24 |
== Gallery Macro == |
|
25 |
+ |
25 |
25 |
{{example}} |
|
27 |
+ |
26 |
26 |
{{gallery}} |
27 |
27 |
[[image:photo1.jpg]] |
28 |
28 |
[[image:photo2.jpg]] |
29 |
29 |
{{/gallery}} |
|
32 |
+ |
30 |
30 |
{{/example}} |
31 |
|
-``` |
32 |
32 |
|
33 |
|
-**Why it's good:** New users see both source and result without confusion. |
34 |
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 |
42 |
== Boilerplate Box == |
43 |
43 |
{{example}} |
44 |
44 |
{{box cssClass="highlight"}} |
... |
... |
@@ -45,15 +45,7 @@ |
45 |
45 |
Insert your highlighted content here. |
46 |
46 |
{{/box}} |
47 |
47 |
{{/example}} |
48 |
|
-``` |
49 |
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 |
57 |
== Velocity Greeting == |
58 |
58 |
{{example}} |
59 |
59 |
{{velocity}} |
... |
... |
@@ -61,15 +61,8 @@ |
61 |
61 |
Hello, $name! |
62 |
62 |
{{/velocity}} |
63 |
63 |
{{/example}} |
64 |
|
-``` |
65 |
65 |
|
66 |
|
---- |
67 |
67 |
|
68 |
|
-## 🎯 4. **Comparing Macro Parameters** |
69 |
|
- |
70 |
|
-Demonstrate how different macro parameters change output—side-by-side. |
71 |
|
- |
72 |
|
-```xwiki |
73 |
73 |
== Info vs Warning == |
74 |
74 |
{{example}} |
75 |
75 |
{{info}}This is an info box.{{/info}} |
... |
... |
@@ -76,29 +76,13 @@ |
76 |
76 |
|
77 |
77 |
{{warning}}This is a warning box.{{/warning}} |
78 |
78 |
{{/example}} |
79 |
|
-``` |
80 |
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 |
88 |
== Footnote Demo == |
89 |
89 |
{{example}} |
90 |
90 |
This claim needs a source{{footnote}}Here it is.{{/footnote}}. |
91 |
91 |
{{putFootnotes/}} |
92 |
92 |
{{/example}} |
93 |
|
-``` |
94 |
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 |
102 |
== Groovy Lookup == |
103 |
103 |
{{example}} |
104 |
104 |
{{groovy}} |
... |
... |
@@ -106,15 +106,8 @@ |
106 |
106 |
println("Current time: " + now) |
107 |
107 |
{{/groovy}} |
108 |
108 |
{{/example}} |
109 |
|
-``` |
110 |
110 |
|
111 |
|
---- |
112 |
112 |
|
113 |
|
-## 📦 7. **Component/API Call Demos** |
114 |
|
- |
115 |
|
-Useful for devs exploring the API. |
116 |
|
- |
117 |
|
-```xwiki |
118 |
118 |
== Access Current User == |
119 |
119 |
{{example}} |
120 |
120 |
{{velocity}} |
... |
... |
@@ -121,15 +121,8 @@ |
121 |
121 |
Current user: **$xcontext.user** |
122 |
122 |
{{/velocity}} |
123 |
123 |
{{/example}} |
124 |
|
-``` |
125 |
125 |
|
126 |
|
---- |
127 |
127 |
|
128 |
|
-## 📘 8. **Expandable Wiki Templates with Output** |
129 |
|
- |
130 |
|
-Pair `{{example}}` with `{{expandable}}` for full disclosure without visual clutter. |
131 |
|
- |
132 |
|
-```xwiki |
133 |
133 |
== Expandable Summary == |
134 |
134 |
{{example}} |
135 |
135 |
{{expandable summary="🧠 Study Summary"}} |
... |
... |
@@ -136,15 +136,7 @@ |
136 |
136 |
Key findings go here. |
137 |
137 |
{{/expandable}} |
138 |
138 |
{{/example}} |
139 |
|
-``` |
140 |
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 |
148 |
== List Formatting == |
149 |
149 |
{{example}} |
150 |
150 |
*Bad formatting* |
... |
... |
@@ -153,13 +153,7 @@ |
153 |
153 |
* Consistent bullet style |
154 |
154 |
* Indented items properly |
155 |
155 |
{{/example}} |
156 |
|
-``` |
157 |
157 |
|
158 |
|
---- |
159 |
|
- |
160 |
|
-## 💡 Bonus Tip: Combine `{{example}}` + `{{code}}` for Highlighted Snippets |
161 |
|
- |
162 |
|
-```xwiki |
163 |
163 |
== Python Code == |
164 |
164 |
{{example}} |
165 |
165 |
{{code language="python"}} |
... |
... |
@@ -167,13 +167,17 @@ |
167 |
167 |
print("Hello World") |
168 |
168 |
{{/code}} |
169 |
169 |
{{/example}} |
170 |
|
-``` |
171 |
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 |
|
- |
|
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 |
+ |
177 |
177 |
This page covers all the essential steps and tips you need to create great content in XWiki without any confusion. |
178 |
178 |
|
179 |
179 |
== == |