0 Votes

Changes for page Start here if you're new

Last modified by Ryan C on 2025/05/14 17:18

From version 31.1
edited by Ryan C
on 2025/05/14 15:48
Change comment: There is no comment for this version
To version 32.1
edited by Ryan C
on 2025/05/14 15:58
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -14,6 +14,23 @@
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 +
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 +
17 17  ----
18 18  
19 19  ## 🧪 1. **Macro Showcase: Source-to-Output Toggle**##
... ... @@ -30,9 +30,9 @@
30 30  {{/gallery}}
31 31  {{/example}}
32 32  
33 -Alternatively 
34 -\\
35 35  
51 +== Alternatively `/carousel` ==
52 +
36 36  {{example}}
37 37  {{carousel/}}
38 38  
... ... @@ -57,7 +57,7 @@
57 57  {{/example}}
58 58  
59 59  
60 -== Info vs Warning ==
77 +== Info vs Warning `/info box` ==
61 61  
62 62  {{example}}
63 63  {{info}}
... ... @@ -69,7 +69,7 @@
69 69  {{/warning}}
70 70  {{/example}}
71 71  
72 -== Footnote Demo ==
89 +== Footnote Demo `/footnote and /put footnotes` put the put footnotes macro at the bottom where you want the references ==
73 73  
74 74  {{example}}
75 75  footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}}
... ... @@ -88,7 +88,7 @@
88 88  {{/example}}
89 89  
90 90  
91 -== Expandable Summary ==
108 +== Expandable Summary `/expandable`  VERY USEFUL MACRO ==
92 92  
93 93  {{example}}
94 94  {{expandable summary="🧠 Study Summary"}}
... ... @@ -116,21 +116,9 @@
116 116  {{/code}}
117 117  {{/example}}
118 118  
119 -== Audio Embedding ==
120 -
121 -{{example}}
122 -{{html}}
123 -<audio controls>
124 - <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
125 - Your browser does not support the audio element.
126 -</audio>
127 -{{/html}}
128 -{{/example}}
129 -
130 -This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
131 -
132 132  == ==
133 133  
138 +
134 134  == 📎 **Attachments and Images** ==
135 135  
136 136  You can easily upload files and images directly from the WYSIWYG editor:
... ... @@ -142,6 +142,19 @@
142 142  * Drag-and-drop or select your file to upload it instantly.
143 143  * Uploaded files will automatically be listed as attachments at the bottom of your page.
144 144  
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 +
145 145  === **Inserting Images with Enlargable Thumbnails** ===
146 146  
147 147  1. In the editor, click the **"Insert Image"** icon from the toolbar.
... ... @@ -150,25 +150,25 @@
150 150  
151 151  [[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]]
152 152  
153 -----
171 +== ==
154 154  
155 -== ⚡ **Using the / Macro Shortcut** ==
173 +(((
174 +=== **You can also use this format to insert images** ===
156 156  
157 -The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
176 +{{example}}
177 +~[~[image~:1747262485678-297.png]]
178 +{{/example}}
158 158  
159 -* Simply type / and start typing the macro name or feature you want to add.
160 -* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
161 -* Example macros include:
162 -** /toc – Table of Contents
163 -** /box – Insert Box Macro
164 -** /gallery – Image Gallery
165 -** /footnote – Add footnotes to your text
166 -** /code – Code blocks for programming snippets
180 +
181 +)))
167 167  
168 -This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax.
183 +{{code}}
184 + [[image:example.jpg]]
185 +{{/code}}
169 169  
170 -----
171 171  
188 +== ==
189 +
172 172  == ✏️** Basic Formatting and Links (Quick Guide)** ==
173 173  
174 174  * **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
... ... @@ -211,7 +211,6 @@
211 211  
212 212  * **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
213 213  * **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.
214 -* **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.
215 215  
216 216  == **Essential Formatting Options** ==
217 217  
... ... @@ -226,62 +226,6 @@
226 226  {{/code}}
227 227  
228 228  
229 -=== **Text Formatting** ===
230 -
231 -
232 -
233 -*
234 -** (((
235 -=== **Bold**: Surround text with double asterisks. ===
236 -)))
237 -
238 -{{code}}
239 -**bold text**
240 -{{/code}}
241 -
242 -
243 -*
244 -** (((
245 -=== **Italics**: Use double underscores. ===
246 -)))
247 -
248 -{{code}}
249 -__italic text__
250 -{{/code}}
251 -
252 -
253 -*
254 -** (((
255 -=== **Underline**: Enclose text with double tildes. ===
256 -)))
257 -
258 -{{code}}
259 -~~underlined text~~
260 -{{/code}}
261 -
262 -
263 -*
264 -** (((
265 -=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
266 -)))
267 -
268 -{{code}}
269 -* Item 1
270 -* Item 2
271 -{{/code}}
272 -
273 -
274 -*
275 -** (((
276 -=== **Ordered List**: Start lines with a number followed by a period. ===
277 -)))
278 -
279 -{{code}}
280 -1. First item
281 -2. Second item
282 -{{/code}}
283 -
284 -
285 285  == **Links** ==
286 286  
287 287  
... ... @@ -301,14 +301,9 @@
301 301  {{/code}}
302 302  
303 303  (((
304 -=== **Images** ===
265 +=== ===
305 305  )))
306 306  
307 -{{code}}
308 - [[image:example.jpg]]
309 -{{/code}}
310 -
311 -
312 312  == **Utilizing XWiki Macros** ==
313 313  
314 314  Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider: