Changes for page Start here if you're new
Last modified by Ryan C on 2025/06/28 04:59
From 21.1 to 22.1
Show context
Hide context
Summary
Details
-
Page properties
-
- Content
-
... ... @@ -12,16 +12,17 @@ 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 - Showhow a macroworkswithout cluttering thepage with raw syntax.21 +In this section we will go over many of the common macros used. The source code is how you use the macro editing in Wiki mode. If you are doing standard WYSIWYG edit mode (the default mode you get when you click edit instead of the dropdown), you can call most of these macros by simply typing /thecommand 22 22 23 -```xwiki 24 -== Gallery Macro == 23 + 24 +== Gallery Macro `/gallery` == 25 + 25 25 {{example}} 26 26 {{gallery}} 27 27 [[image:photo1.jpg]] ... ... @@ -28,33 +28,18 @@ 28 28 [[image:photo2.jpg]] 29 29 {{/gallery}} 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 == 35 + 43 43 {{example}} 44 44 {{box cssClass="highlight"}} 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 == 43 + 58 58 {{example}} 59 59 {{velocity}} 60 60 #set($name = "Visitor") ... ... @@ -61,45 +61,31 @@ 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 == 53 + 74 74 {{example}} 75 -{{info}}This is an info box.{{/info}} 55 +{{info}} 56 +This is an info box. 57 +{{/info}} 76 76 77 -{{warning}}This is a warning box.{{/warning}} 59 +{{warning}} 60 +This is a warning box. 61 +{{/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 == 65 + 89 89 {{example}} 90 -This claim needs a source{{footnote}}Here it is.{{/footnote}}. 67 +footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}} 68 + 91 91 {{putFootnotes/}} 92 92 {{/example}} 93 -``` 94 94 95 ---- 96 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 == 74 + 103 103 {{example}} 104 104 {{groovy}} 105 105 def now = new Date() ... ... @@ -106,61 +106,29 @@ 106 106 println("Current time: " + now) 107 107 {{/groovy}} 108 108 {{/example}} 109 -``` 110 110 111 ---- 112 112 113 - ##📦 7. **Component/API Call Demos**83 +== Expandable Summary == 114 114 115 -Useful for devs exploring the API. 116 - 117 -```xwiki 118 -== Access Current User == 119 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 135 {{expandable summary="🧠 Study Summary"}} 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 == 92 + 149 149 {{example}} 150 150 *Bad formatting* 95 + 151 151 * use - inconsistently 152 152 ** Good formatting: 153 - 154 - 98 +* Consistent bullet style 99 +* 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 == 103 + 164 164 {{example}} 165 165 {{code language="python"}} 166 166 def greet(): ... ... @@ -167,16 +167,21 @@ 167 167 print("Hello World") 168 168 {{/code}} 169 169 {{/example}} 170 -``` 171 171 172 - ---111 +== Audio Embedding == 173 173 174 -Want me to generate a panel with these uses or make a macro gallery page pre-filled with them? 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}} 175 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 -== 124 +== == 180 180 181 181 == 📎 **Attachments and Images** == 182 182 ... ... @@ -195,6 +195,8 @@ 195 195 1. Upload or select the image. 196 196 1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically. 197 197 143 +[[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]] 144 + 198 198 ---- 199 199 200 200 == ⚡ **Using the / Macro Shortcut** == ... ... @@ -424,12 +424,12 @@ 424 424 == Example Macro == 425 425 426 426 The example macro displays the output of a macro or script or anything that you like 374 + 427 427 == Expandable Macro == 428 428 429 429 The following example demonstrates how to present complex information cleanly using ` 430 430 431 431 {{example}} 432 - 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* ... ... @@ -499,4 +499,4 @@ 499 499 {{/example}} 500 500 501 501 502 - 449 +
-
1747262485678-297.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.AdminAngriff - Size
-
... ... @@ -1,0 +1,1 @@ 1 +1.6 MB -
Content
