Changes for page Start here if you're new
Last modified by Ryan C on 2025/06/28 04:59
From 19.1 to 20.1
Show context
Hide context
Summary
Details
-
Page properties
-
- Content
-
... ... @@ -12,10 +12,130 @@ 12 12 13 13 == Getting Started with XWiki == 14 14 15 -Th ispage covers allthe essentialstepsand tips youneed tocreategreatcontentinXWikiwithoutanyconfusion.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 -== == 18 18 18 + 19 +== ⚡ **Using the / Macro Shortcut** == 20 + 21 +The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor: 22 + 23 +* Simply type / and start typing the macro name or feature you want to add. 24 +* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax. 25 +* Example macros include: 26 +** /toc – Table of Contents 27 +** /box – Insert Box Macro 28 +** /gallery – Image Gallery 29 +** /footnote – Add footnotes to your text 30 +** /code – Code blocks for programming snippets 31 + 32 +This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax 33 + 34 +---- 35 + 36 +## 🧪 1. **Macro Showcase: Source-to-Output Toggle**## 37 + 38 +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 39 + 40 + 41 +== Gallery Macro `/gallery` == 42 + 43 +{{example}} 44 +{{gallery}} 45 +[[1747262485678-297.png]] 46 +[[image:photo2.jpg]] 47 +{{/gallery}} 48 +{{/example}} 49 + 50 + 51 +== Alternatively `/carousel` == 52 + 53 +{{example}} 54 +{{carousel/}} 55 + 56 + 57 +{{/example}} 58 + 59 +== Boilerplate Box == 60 + 61 +{{example}} 62 +{{box cssClass="highlight"}} 63 +Insert your highlighted content here. 64 +{{/box}} 65 +{{/example}} 66 + 67 +== Velocity Greeting == 68 + 69 +{{example}} 70 +{{velocity}} 71 +#set($name = "Visitor") 72 +Hello, $name! 73 +{{/velocity}} 74 +{{/example}} 75 + 76 + 77 +== Info vs Warning `/info box` == 78 + 79 +{{example}} 80 +{{info}} 81 +This is an info box. 82 +{{/info}} 83 + 84 +{{warning}} 85 +This is a warning box. 86 +{{/warning}} 87 +{{/example}} 88 + 89 +== Footnote Demo `/footnote and /put footnotes` put the put footnotes macro at the bottom where you want the references == 90 + 91 +{{example}} 92 +footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}} 93 + 94 +{{putFootnotes/}} 95 +{{/example}} 96 + 97 + 98 +== Groovy Lookup == 99 + 100 +{{example}} 101 +{{groovy}} 102 +def now = new Date() 103 +println("Current time: " + now) 104 +{{/groovy}} 105 +{{/example}} 106 + 107 + 108 +== Expandable Summary `/expandable` VERY USEFUL MACRO == 109 + 110 +{{example}} 111 +{{expandable summary="🧠 Study Summary"}} 112 +Key findings go here. 113 +{{/expandable}} 114 +{{/example}} 115 + 116 +== List Formatting == 117 + 118 +{{example}} 119 +*Bad formatting* 120 + 121 +* use - inconsistently 122 +** Good formatting: 123 +* Consistent bullet style 124 +* Indented items properly 125 +{{/example}} 126 + 127 +== Python Code == 128 + 129 +{{example}} 130 +{{code language="python"}} 131 +def greet(): 132 + print("Hello World") 133 +{{/code}} 134 +{{/example}} 135 + 136 +== == 137 + 138 + 19 19 == 📎 **Attachments and Images** == 20 20 21 21 You can easily upload files and images directly from the WYSIWYG editor: ... ... @@ -27,6 +27,19 @@ 27 27 * Drag-and-drop or select your file to upload it instantly. 28 28 * Uploaded files will automatically be listed as attachments at the bottom of your page. 29 29 150 +== Audio Embedding for attached media its better to use the code sometimes but you can embed media with `/embed content` for external media and `/embed JWPlayer` == 151 + 152 +{{example}} 153 +{{html}} 154 +<audio controls> 155 + <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg"> 156 + Your browser does not support the audio element. 157 +</audio> 158 +{{/html}} 159 +{{/example}} 160 + 161 +This page covers all the essential steps and tips you need to create great content in XWiki without any confusion. 162 + 30 30 === **Inserting Images with Enlargable Thumbnails** === 31 31 32 32 1. In the editor, click the **"Insert Image"** icon from the toolbar. ... ... @@ -33,25 +33,27 @@ 33 33 1. Upload or select the image. 34 34 1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically. 35 35 36 ----- 169 +[[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]] 37 37 38 -== ⚡**Using the / Macro Shortcut**==171 +== == 39 39 40 -The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor: 173 +((( 174 +=== **You can also use this format to insert images** === 41 41 42 -* Simply type / and start typing the macro name or feature you want to add. 43 -* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax. 44 -* Example macros include: 45 -** /toc – Table of Contents 46 -** /box – Insert Box Macro 47 -** /gallery – Image Gallery 48 -** /footnote – Add footnotes to your text 49 -** /code – Code blocks for programming snippets 176 +{{example}} 177 +~[~[image~:1747262485678-297.png]] 178 +{{/example}} 50 50 51 -This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax. 180 + 181 +))) 52 52 53 ----- 183 +{{code}} 184 + [[image:example.jpg]] 185 +{{/code}} 54 54 187 + 188 +== == 189 + 55 55 == ✏️** Basic Formatting and Links (Quick Guide)** == 56 56 57 57 * **Bold text**: Select text, click the **Bold** button or press Ctrl + B. ... ... @@ -94,7 +94,6 @@ 94 94 95 95 * **WYSIWYG (What You See Is What You Get) Editor**: Ideal for users unfamiliar with wiki syntax, this editor provides a user-friendly interface resembling traditional word processors. It allows for straightforward text formatting, image insertion, and link creation without delving into markup language. citeturn0search0 96 96 * **Wiki Editor**: This mode enables direct editing using XWiki’s markup syntax. It’s suitable for users comfortable with wiki syntax and those requiring precise control over the content structure. 97 -* **Inline Form Editing**: Used primarily for pages containing structured data or custom applications, this mode presents editable fields directly within the page view, streamlining data entry and updates. 98 98 99 99 == **Essential Formatting Options** == 100 100 ... ... @@ -109,62 +109,6 @@ 109 109 {{/code}} 110 110 111 111 112 -=== **Text Formatting** === 113 - 114 - 115 - 116 -* 117 -** ((( 118 -=== **Bold**: Surround text with double asterisks. === 119 -))) 120 - 121 -{{code}} 122 -**bold text** 123 -{{/code}} 124 - 125 - 126 -* 127 -** ((( 128 -=== **Italics**: Use double underscores. === 129 -))) 130 - 131 -{{code}} 132 -__italic text__ 133 -{{/code}} 134 - 135 - 136 -* 137 -** ((( 138 -=== **Underline**: Enclose text with double tildes. === 139 -))) 140 - 141 -{{code}} 142 -~~underlined text~~ 143 -{{/code}} 144 - 145 - 146 -* 147 -** ((( 148 -=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). === 149 -))) 150 - 151 -{{code}} 152 -* Item 1 153 -* Item 2 154 -{{/code}} 155 - 156 - 157 -* 158 -** ((( 159 -=== **Ordered List**: Start lines with a number followed by a period. === 160 -))) 161 - 162 -{{code}} 163 -1. First item 164 -2. Second item 165 -{{/code}} 166 - 167 - 168 168 == **Links** == 169 169 170 170 ... ... @@ -184,14 +184,9 @@ 184 184 {{/code}} 185 185 186 186 ((( 187 -=== **Images**===265 +=== === 188 188 ))) 189 189 190 -{{code}} 191 - [[image:example.jpg]] 192 -{{/code}} 193 - 194 - 195 195 == **Utilizing XWiki Macros** == 196 196 197 197 Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider: ... ... @@ -258,11 +258,16 @@ 258 258 {{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}} 259 259 {{/example}} 260 260 334 + 335 +== Example Macro == 336 + 337 +The example macro displays the output of a macro or script or anything that you like 338 + 261 261 == Expandable Macro == 262 262 263 263 The following example demonstrates how to present complex information cleanly using ` 264 264 265 - 343 +{{example}} 266 266 {{expandable summary="Study: The Wilson Effect: The Increase in Heritability of IQ With Age"}} 267 267 **Source:** *Twin Research and Human Genetics (Cambridge University Press)* 268 268 **Date of Publication:** *2013* ... ... @@ -329,4 +329,7 @@ 329 329 [[Download Full Study>>attach:10.1017_thg.2013.54.pdf]] 330 330 {{/expandable}} 331 331 {{/expandable}} 410 +{{/example}} 332 332 412 + 413 +
-
1747262485678-297.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.AdminAngriff - Size
-
... ... @@ -1,0 +1,1 @@ 1 +1.6 MB -
Content
