0 Votes

Changes for page Start here if you're new

Last modified by Ryan C on 2025/06/28 04:59

From version 33.1
edited by Ryan C
on 2025/05/14 15:59
Change comment: There is no comment for this version
To version 24.1
edited by Ryan C
on 2025/05/14 15:36
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -14,50 +14,26 @@
14 14  
15 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 17  
19 +## 🧪 1. **Macro Showcase: Source-to-Output Toggle**
18 18  
19 -== ⚡ **Using the / Macro Shortcut** ==
21 +Show how a macro works without cluttering the page with raw syntax.
20 20  
21 -The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
22 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
24 +== Gallery Macro ==
31 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 43  {{example}}
27 +
44 44  {{gallery}}
45 -[[1747262485678-297.png]]
29 +[[image:photo1.jpg]]
46 46  [[image:photo2.jpg]]
47 47  {{/gallery}}
48 -{{/example}}
49 49  
50 -
51 -== Alternatively `/carousel` ==
52 -
53 -{{example}}
54 -{{carousel/}}
55 -
56 -
57 57  {{/example}}
58 58  
59 -== Boilerplate Box ==
60 60  
36 +== Boilerplate Box ==
61 61  {{example}}
62 62  {{box cssClass="highlight"}}
63 63  Insert your highlighted content here.
... ... @@ -65,7 +65,6 @@
65 65  {{/example}}
66 66  
67 67  == Velocity Greeting ==
68 -
69 69  {{example}}
70 70  {{velocity}}
71 71  #set($name = "Visitor")
... ... @@ -74,29 +74,18 @@
74 74  {{/example}}
75 75  
76 76  
77 -== Info vs Warning `/info box` ==
78 -
52 +== Info vs Warning ==
79 79  {{example}}
80 -{{info}}
81 -This is an info box.
82 -{{/info}}
54 +{{info}}This is an info box.{{/info}}
83 83  
84 -{{warning}}
85 -This is a warning box.
86 -{{/warning}}
56 +{{warning}}This is a warning box.{{/warning}}
87 87  {{/example}}
88 88  
89 -== Footnote Demo `/footnote and /put footnotes` put the put footnotes macro at the bottom where you want the references ==
59 +== Footnote Demo ==
90 90  
91 -{{example}}
92 -footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}}
61 +footnote
93 93  
94 -{{putFootnotes/}}
95 -{{/example}}
96 -
97 -
98 98  == Groovy Lookup ==
99 -
100 100  {{example}}
101 101  {{groovy}}
102 102  def now = new Date()
... ... @@ -105,8 +105,7 @@
105 105  {{/example}}
106 106  
107 107  
108 -== Expandable Summary `/expandable`  VERY USEFUL MACRO ==
109 -
72 +== Expandable Summary ==
110 110  {{example}}
111 111  {{expandable summary="🧠 Study Summary"}}
112 112  Key findings go here.
... ... @@ -114,18 +114,15 @@
114 114  {{/example}}
115 115  
116 116  == List Formatting ==
117 -
118 118  {{example}}
119 119  *Bad formatting*
120 -
121 121  * use - inconsistently
122 122  ** Good formatting:
123 -* Consistent bullet style
124 -* Indented items properly
84 + * Consistent bullet style
85 + * Indented items properly
125 125  {{/example}}
126 126  
127 127  == Python Code ==
128 -
129 129  {{example}}
130 130  {{code language="python"}}
131 131  def greet():
... ... @@ -133,9 +133,21 @@
133 133  {{/code}}
134 134  {{/example}}
135 135  
136 -== ==
96 +== Audio Embedding ==
97 +{{example}}
137 137  
99 +{{html}}
100 +<audio controls>
101 + <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
102 + Your browser does not support the audio element.
103 +</audio>
104 +{{/html}}
105 +{{/example}}
138 138  
107 +This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
108 +
109 +== ==
110 +
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"]]
128 +----
170 170  
130 +== ⚡ **Using the / Macro Shortcut** ==
171 171  
132 +The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
172 172  
134 +* Simply type / and start typing the macro name or feature you want to add.
135 +* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
136 +* Example macros include:
137 +** /toc – Table of Contents
138 +** /box – Insert Box Macro
139 +** /gallery – Image Gallery
140 +** /footnote – Add footnotes to your text
141 +** /code – Code blocks for programming snippets
173 173  
174 -=== **You can also use this format to insert images** ===
143 +This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax.
175 175  
176 -{{example}}
177 -[[image:1747262485678-297.png]]
178 -{{/example}}
145 +----
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. citeturn0search0
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.
189 +* **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  
204 +=== **Text Formatting** ===
205 +
206 +
207 +
208 +*
209 +** (((
210 +=== **Bold**: Surround text with double asterisks. ===
211 +)))
212 +
213 +{{code}}
214 +**bold text**
215 +{{/code}}
216 +
217 +
218 +*
219 +** (((
220 +=== **Italics**: Use double underscores. ===
221 +)))
222 +
223 +{{code}}
224 +__italic text__
225 +{{/code}}
226 +
227 +
228 +*
229 +** (((
230 +=== **Underline**: Enclose text with double tildes. ===
231 +)))
232 +
233 +{{code}}
234 +~~underlined text~~
235 +{{/code}}
236 +
237 +
238 +*
239 +** (((
240 +=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
241 +)))
242 +
243 +{{code}}
244 +* Item 1
245 +* Item 2
246 +{{/code}}
247 +
248 +
249 +*
250 +** (((
251 +=== **Ordered List**: Start lines with a number followed by a period. ===
252 +)))
253 +
254 +{{code}}
255 +1. First item
256 +2. Second item
257 +{{/code}}
258 +
259 +
246 246  == **Links** ==
247 247  
248 248  
... ... @@ -262,9 +262,14 @@
262 262  {{/code}}
263 263  
264 264  (((
265 -=== ===
279 +=== **Images** ===
266 266  )))
267 267  
282 +{{code}}
283 + [[image:example.jpg]]
284 +{{/code}}
285 +
286 +
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:
... ... @@ -335,12 +335,12 @@
335 335  == Example Macro ==
336 336  
337 337  The example macro displays the output of a macro or script or anything that you like
338 -
339 339  == Expandable Macro ==
340 340  
341 341  The following example demonstrates how to present complex information cleanly using `
342 342  
343 343  {{example}}
362 +
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*
... ... @@ -410,4 +410,4 @@
410 410  {{/example}}
411 411  
412 412  
413 -
432 +
1747262485678-297.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.AdminAngriff
Size
... ... @@ -1,1 +1,0 @@
1 -1.6 MB
Content