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,130 +12,10 @@ 12 12 13 13 == Getting Started with XWiki == 14 14 15 -Th eexamplemacroin XWiki is anunderratedpowerhouse—greatfor *teaching*, *showcasingmacros*, *hiding complex markup*,and*letting usersplaywith source-outputpairs*. Herearesome**highlyeffectiveandinterestinguses**:15 +This page covers all the essential steps and tips you need to create great content in XWiki without any confusion. 16 16 17 +== == 17 17 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 - 139 139 == 📎 **Attachments and Images** == 140 140 141 141 You can easily upload files and images directly from the WYSIWYG editor: ... ... @@ -147,19 +147,6 @@ 147 147 * Drag-and-drop or select your file to upload it instantly. 148 148 * Uploaded files will automatically be listed as attachments at the bottom of your page. 149 149 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 - 163 163 === **Inserting Images with Enlargable Thumbnails** === 164 164 165 165 1. In the editor, click the **"Insert Image"** icon from the toolbar. ... ... @@ -166,27 +166,25 @@ 166 166 1. Upload or select the image. 167 167 1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically. 168 168 169 - [[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]]36 +---- 170 170 38 +== ⚡ **Using the / Macro Shortcut** == 171 171 40 +The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor: 172 172 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 173 173 174 - ===**Youcanalsouse thisformattoinsertimages**===51 +This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax. 175 175 176 -{{example}} 177 -[[image:1747262485678-297.png]] 178 -{{/example}} 53 +---- 179 179 180 - 181 - 182 - 183 -{{code}} 184 - [[image:example.jpg]] 185 -{{/code}} 186 - 187 - 188 - 189 - 190 190 == ✏️** Basic Formatting and Links (Quick Guide)** == 191 191 192 192 * **Bold text**: Select text, click the **Bold** button or press Ctrl + B. ... ... @@ -229,6 +229,7 @@ 229 229 230 230 * **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 231 231 * **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. 232 232 233 233 == **Essential Formatting Options** == 234 234 ... ... @@ -243,6 +243,62 @@ 243 243 {{/code}} 244 244 245 245 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 + 246 246 == **Links** == 247 247 248 248 ... ... @@ -262,9 +262,14 @@ 262 262 {{/code}} 263 263 264 264 ((( 265 -=== 187 +=== **Images** === 266 266 ))) 267 267 190 +{{code}} 191 + [[image:example.jpg]] 192 +{{/code}} 193 + 194 + 268 268 == **Utilizing XWiki Macros** == 269 269 270 270 Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider: ... ... @@ -331,16 +331,12 @@ 331 331 {{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}} 332 332 {{/example}} 333 333 334 - 335 -== Example Macro == 336 - 337 -The example macro displays the output of a macro or script or anything that you like 338 - 339 339 == Expandable Macro == 262 +The following example demonstrates how to present complex information cleanly using `{{expandable}}` and `{{example}}`. 340 340 341 -The following example demonstrates how to present complex information cleanly using ` 342 - 343 343 {{example}} 265 + 266 + 344 344 {{expandable summary="Study: The Wilson Effect: The Increase in Heritability of IQ With Age"}} 345 345 **Source:** *Twin Research and Human Genetics (Cambridge University Press)* 346 346 **Date of Publication:** *2013* ... ... @@ -407,7 +407,8 @@ 407 407 [[Download Full Study>>attach:10.1017_thg.2013.54.pdf]] 408 408 {{/expandable}} 409 409 {{/expandable}} 410 -{{/example}} 411 411 412 412 413 - 335 +== See Also: == 336 + 337 +[[Syntax Help official documentation for a full list of formatting options>>doc:XWiki.XWikiSyntax]]
-
1747262485678-297.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.AdminAngriff - Size
-
... ... @@ -1,1 +1,0 @@ 1 -1.6 MB -
Content
