Changes for page Start here if you're new
Last modified by Ryan C on 2025/06/28 04:59
From 17.1 to 16.1
Show context
Hide context
Summary
Details
-
Page properties
-
- Content
-
... ... @@ -12,168 +12,6 @@ 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 -```xwiki 24 -== Gallery Macro == 25 -{{example}} 26 -{{gallery}} 27 -[[image:photo1.jpg]] 28 -[[image:photo2.jpg]] 29 -{{/gallery}} 30 -{{/example}} 31 -``` 32 - 33 -**Why it's good:** New users see both source and result without confusion. 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 -== Boilerplate Box == 43 -{{example}} 44 -{{box cssClass="highlight"}} 45 -Insert your highlighted content here. 46 -{{/box}} 47 -{{/example}} 48 -``` 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 -== Velocity Greeting == 58 -{{example}} 59 -{{velocity}} 60 -#set($name = "Visitor") 61 -Hello, $name! 62 -{{/velocity}} 63 -{{/example}} 64 -``` 65 - 66 ---- 67 - 68 -## 🎯 4. **Comparing Macro Parameters** 69 - 70 -Demonstrate how different macro parameters change output—side-by-side. 71 - 72 -```xwiki 73 -== Info vs Warning == 74 -{{example}} 75 -{{info}}This is an info box.{{/info}} 76 - 77 -{{warning}}This is a warning box.{{/warning}} 78 -{{/example}} 79 -``` 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 -== Footnote Demo == 89 -{{example}} 90 -This claim needs a source{{footnote}}Here it is.{{/footnote}}. 91 -{{putFootnotes/}} 92 -{{/example}} 93 -``` 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 -== Groovy Lookup == 103 -{{example}} 104 -{{groovy}} 105 -def now = new Date() 106 -println("Current time: " + now) 107 -{{/groovy}} 108 -{{/example}} 109 -``` 110 - 111 ---- 112 - 113 -## 📦 7. **Component/API Call Demos** 114 - 115 -Useful for devs exploring the API. 116 - 117 -```xwiki 118 -== Access Current User == 119 -{{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}} 135 -{{expandable summary="🧠 Study Summary"}} 136 -Key findings go here. 137 -{{/expandable}} 138 -{{/example}} 139 -``` 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 -== List Formatting == 149 -{{example}} 150 -*Bad formatting* 151 -* use - inconsistently 152 -** Good formatting: 153 - * Consistent bullet style 154 - * Indented items properly 155 -{{/example}} 156 -``` 157 - 158 ---- 159 - 160 -## 💡 Bonus Tip: Combine `{{example}}` + `{{code}}` for Highlighted Snippets 161 - 162 -```xwiki 163 -== Python Code == 164 -{{example}} 165 -{{code language="python"}} 166 -def greet(): 167 - print("Hello World") 168 -{{/code}} 169 -{{/example}} 170 -``` 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 - 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 == == ... ... @@ -275,7 +275,7 @@ 275 275 276 276 277 277 278 -* 116 +* 279 279 ** ((( 280 280 === **Bold**: Surround text with double asterisks. === 281 281 ))) ... ... @@ -285,7 +285,7 @@ 285 285 {{/code}} 286 286 287 287 288 -* 126 +* 289 289 ** ((( 290 290 === **Italics**: Use double underscores. === 291 291 ))) ... ... @@ -295,7 +295,7 @@ 295 295 {{/code}} 296 296 297 297 298 -* 136 +* 299 299 ** ((( 300 300 === **Underline**: Enclose text with double tildes. === 301 301 ))) ... ... @@ -305,7 +305,7 @@ 305 305 {{/code}} 306 306 307 307 308 -* 146 +* 309 309 ** ((( 310 310 === **Unordered List**: Begin lines with asterisk (*) or hyphen (-). === 311 311 ))) ... ... @@ -316,7 +316,7 @@ 316 316 {{/code}} 317 317 318 318 319 -* 157 +* 320 320 ** ((( 321 321 === **Ordered List**: Start lines with a number followed by a period. === 322 322 ))) ... ... @@ -420,16 +420,12 @@ 420 420 {{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}} 421 421 {{/example}} 422 422 423 - 424 -== Example Macro == 425 - 426 -The example macro displays the output of a macro or script or anything that you like 427 427 == Expandable Macro == 262 +The following example demonstrates how to present complex information cleanly using `{{expandable}}` and `{{example}}`. 428 428 429 -The following example demonstrates how to present complex information cleanly using ` 430 - 431 431 {{example}} 432 - 265 + 266 + 433 433 {{expandable summary="Study: The Wilson Effect: The Increase in Heritability of IQ With Age"}} 434 434 **Source:** *Twin Research and Human Genetics (Cambridge University Press)* 435 435 **Date of Publication:** *2013* ... ... @@ -496,7 +496,8 @@ 496 496 [[Download Full Study>>attach:10.1017_thg.2013.54.pdf]] 497 497 {{/expandable}} 498 498 {{/expandable}} 499 -{{/example}} 500 500 501 501 335 +== See Also: == 502 502 337 +[[Syntax Help official documentation for a full list of formatting options>>doc:XWiki.XWikiSyntax]]