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,29 +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 - 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.)** 67 67 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}}. 68 68 {{putFootnotes/}} 92 +{{/example}} 93 +``` 69 69 95 +--- 70 70 71 - ==GroovyLookup==97 +## 🧪 6. **Live Scripting Playgrounds** 72 72 99 +Embed small self-contained scripting playgrounds where users can view or modify dynamic output. 100 + 101 +```xwiki 102 +== Groovy Lookup == 73 73 {{example}} 74 74 {{groovy}} 75 75 def now = new Date() ... ... @@ -76,29 +76,61 @@ 76 76 println("Current time: " + now) 77 77 {{/groovy}} 78 78 {{/example}} 109 +``` 79 79 111 +--- 80 80 81 - ==ExpandableSummary==113 +## 📦 7. **Component/API Call Demos** 82 82 115 +Useful for devs exploring the API. 116 + 117 +```xwiki 118 +== Access Current User == 83 83 {{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}} 84 84 {{expandable summary="🧠 Study Summary"}} 85 85 Key findings go here. 86 86 {{/expandable}} 87 87 {{/example}} 139 +``` 88 88 89 - == List Formatting ==141 +--- 90 90 143 +## 🔧 9. **Syntax Training: Bad vs Good** 144 + 145 +Side-by-side "Do this, not that" with toggles. 146 + 147 +```xwiki 148 +== List Formatting == 91 91 {{example}} 92 92 *Bad formatting* 93 - 94 94 * use - inconsistently 95 95 ** Good formatting: 96 -* Consistent bullet style 97 -* Indented items properly 153 + * Consistent bullet style 154 + * Indented items properly 98 98 {{/example}} 156 +``` 99 99 100 - == Python Code ==158 +--- 101 101 160 +## 💡 Bonus Tip: Combine `{{example}}` + `{{code}}` for Highlighted Snippets 161 + 162 +```xwiki 163 +== Python Code == 102 102 {{example}} 103 103 {{code language="python"}} 104 104 def greet(): ... ... @@ -105,21 +105,16 @@ 105 105 print("Hello World") 106 106 {{/code}} 107 107 {{/example}} 170 +``` 108 108 109 - == Audio Embedding ==172 +--- 110 110 111 -{{example}} 112 -{{html}} 113 -<audio controls> 114 - <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg"> 115 - Your browser does not support the audio element. 116 -</audio> 117 -{{/html}} 118 -{{/example}} 174 +Want me to generate a panel with these uses or make a macro gallery page pre-filled with them? 119 119 176 + 120 120 This page covers all the essential steps and tips you need to create great content in XWiki without any confusion. 121 121 122 -== == 179 +== == 123 123 124 124 == 📎 **Attachments and Images** == 125 125 ... ... @@ -367,12 +367,12 @@ 367 367 == Example Macro == 368 368 369 369 The example macro displays the output of a macro or script or anything that you like 370 - 371 371 == Expandable Macro == 372 372 373 373 The following example demonstrates how to present complex information cleanly using ` 374 374 375 375 {{example}} 432 + 376 376 {{expandable summary="Study: The Wilson Effect: The Increase in Heritability of IQ With Age"}} 377 377 **Source:** *Twin Research and Human Genetics (Cambridge University Press)* 378 378 **Date of Publication:** *2013* ... ... @@ -442,4 +442,4 @@ 442 442 {{/example}} 443 443 444 444 445 - 502 +