Changes for page Start here if you're new
Last modified by Ryan C on 2025/06/28 04:59
From 22.1 to 21.1
Show context
Hide context
Summary
Details
-
Page properties
-
- Content
-
... ... @@ -12,17 +12,16 @@ 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 19 -## 🧪 1. **Macro Showcase: Source-to-Output Toggle** ##19 +## 🧪 1. **Macro Showcase: Source-to-Output Toggle** 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 27 {{gallery}} 28 28 [[image:photo1.jpg]] ... ... @@ -29,18 +29,33 @@ 29 29 [[image:photo2.jpg]] 30 30 {{/gallery}} 31 31 {{/example}} 31 +``` 32 32 33 +**Why it's good:** New users see both source and result without confusion. 33 33 34 - == Boilerplate Box ==35 +--- 35 35 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 == 36 36 {{example}} 37 37 {{box cssClass="highlight"}} 38 38 Insert your highlighted content here. 39 39 {{/box}} 40 40 {{/example}} 48 +``` 41 41 42 - == Velocity Greeting ==50 +--- 43 43 52 +## 🎓 3. **Educational Tutorials (e.g., Velocity or Groovy)** 53 + 54 +Teach scripting with real, live code examples. 55 + 56 +```xwiki 57 +== Velocity Greeting == 44 44 {{example}} 45 45 {{velocity}} 46 46 #set($name = "Visitor") ... ... @@ -47,31 +47,45 @@ 47 47 Hello, $name! 48 48 {{/velocity}} 49 49 {{/example}} 64 +``` 50 50 66 +--- 51 51 52 - ==InfovsWarning==68 +## 🎯 4. **Comparing Macro Parameters** 53 53 70 +Demonstrate how different macro parameters change output—side-by-side. 71 + 72 +```xwiki 73 +== Info vs Warning == 54 54 {{example}} 55 -{{info}} 56 -This is an info box. 57 -{{/info}} 75 +{{info}}This is an info box.{{/info}} 58 58 59 -{{warning}} 60 -This is a warning box. 61 -{{/warning}} 77 +{{warning}}This is a warning box.{{/warning}} 62 62 {{/example}} 79 +``` 63 63 64 - == Footnote Demo ==81 +--- 65 65 66 -{{example}} 67 -footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}} 83 +## 🧩 5. **Interactive Data Blocks (TOC, Footnotes, etc.)** 68 68 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}}. 69 69 {{putFootnotes/}} 70 70 {{/example}} 93 +``` 71 71 95 +--- 72 72 73 - ==GroovyLookup==97 +## 🧪 6. **Live Scripting Playgrounds** 74 74 99 +Embed small self-contained scripting playgrounds where users can view or modify dynamic output. 100 + 101 +```xwiki 102 +== Groovy Lookup == 75 75 {{example}} 76 76 {{groovy}} 77 77 def now = new Date() ... ... @@ -78,29 +78,61 @@ 78 78 println("Current time: " + now) 79 79 {{/groovy}} 80 80 {{/example}} 109 +``` 81 81 111 +--- 82 82 83 - ==ExpandableSummary==113 +## 📦 7. **Component/API Call Demos** 84 84 115 +Useful for devs exploring the API. 116 + 117 +```xwiki 118 +== Access Current User == 85 85 {{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}} 86 86 {{expandable summary="🧠 Study Summary"}} 87 87 Key findings go here. 88 88 {{/expandable}} 89 89 {{/example}} 139 +``` 90 90 91 - == List Formatting ==141 +--- 92 92 143 +## 🔧 9. **Syntax Training: Bad vs Good** 144 + 145 +Side-by-side "Do this, not that" with toggles. 146 + 147 +```xwiki 148 +== List Formatting == 93 93 {{example}} 94 94 *Bad formatting* 95 - 96 96 * use - inconsistently 97 97 ** Good formatting: 98 -* Consistent bullet style 99 -* Indented items properly 153 + * Consistent bullet style 154 + * Indented items properly 100 100 {{/example}} 156 +``` 101 101 102 - == Python Code ==158 +--- 103 103 160 +## 💡 Bonus Tip: Combine `{{example}}` + `{{code}}` for Highlighted Snippets 161 + 162 +```xwiki 163 +== Python Code == 104 104 {{example}} 105 105 {{code language="python"}} 106 106 def greet(): ... ... @@ -107,21 +107,16 @@ 107 107 print("Hello World") 108 108 {{/code}} 109 109 {{/example}} 170 +``` 110 110 111 - == Audio Embedding ==172 +--- 112 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}} 174 +Want me to generate a panel with these uses or make a macro gallery page pre-filled with them? 121 121 176 + 122 122 This page covers all the essential steps and tips you need to create great content in XWiki without any confusion. 123 123 124 -== == 179 +== == 125 125 126 126 == 📎 **Attachments and Images** == 127 127 ... ... @@ -140,8 +140,6 @@ 140 140 1. Upload or select the image. 141 141 1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically. 142 142 143 -[[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]] 144 - 145 145 ---- 146 146 147 147 == ⚡ **Using the / Macro Shortcut** == ... ... @@ -222,7 +222,7 @@ 222 222 223 223 224 224 225 -* 278 +* 226 226 ** ((( 227 227 === **Bold**: Surround text with double asterisks. === 228 228 ))) ... ... @@ -232,7 +232,7 @@ 232 232 {{/code}} 233 233 234 234 235 -* 288 +* 236 236 ** ((( 237 237 === **Italics**: Use double underscores. === 238 238 ))) ... ... @@ -242,7 +242,7 @@ 242 242 {{/code}} 243 243 244 244 245 -* 298 +* 246 246 ** ((( 247 247 === **Underline**: Enclose text with double tildes. === 248 248 ))) ... ... @@ -252,7 +252,7 @@ 252 252 {{/code}} 253 253 254 254 255 -* 308 +* 256 256 ** ((( 257 257 === **Unordered List**: Begin lines with asterisk (*) or hyphen (-). === 258 258 ))) ... ... @@ -263,7 +263,7 @@ 263 263 {{/code}} 264 264 265 265 266 -* 319 +* 267 267 ** ((( 268 268 === **Ordered List**: Start lines with a number followed by a period. === 269 269 ))) ... ... @@ -371,12 +371,12 @@ 371 371 == Example Macro == 372 372 373 373 The example macro displays the output of a macro or script or anything that you like 374 - 375 375 == Expandable Macro == 376 376 377 377 The following example demonstrates how to present complex information cleanly using ` 378 378 379 379 {{example}} 432 + 380 380 {{expandable summary="Study: The Wilson Effect: The Increase in Heritability of IQ With Age"}} 381 381 **Source:** *Twin Research and Human Genetics (Cambridge University Press)* 382 382 **Date of Publication:** *2013* ... ... @@ -446,4 +446,4 @@ 446 446 {{/example}} 447 447 448 448 449 - 502 +
-
1747262485678-297.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.AdminAngriff - Size
-
... ... @@ -1,1 +1,0 @@ 1 -1.6 MB -
Content
