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