0 Votes

Changes for page Start here if you're new

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

From version 30.1
edited by Ryan C
on 2025/05/14 15:46
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**##
... ... @@ -31,6 +31,14 @@
31 31  {{/example}}
32 32  
33 33  
51 +== Alternatively `/carousel` ==
52 +
53 +{{example}}
54 +{{carousel/}}
55 +
56 +
57 +{{/example}}
58 +
34 34  == Boilerplate Box ==
35 35  
36 36  {{example}}
... ... @@ -49,7 +49,7 @@
49 49  {{/example}}
50 50  
51 51  
52 -== Info vs Warning ==
77 +== Info vs Warning `/info box` ==
53 53  
54 54  {{example}}
55 55  {{info}}
... ... @@ -61,7 +61,7 @@
61 61  {{/warning}}
62 62  {{/example}}
63 63  
64 -== Footnote Demo ==
89 +== Footnote Demo `/footnote and /put footnotes` put the put footnotes macro at the bottom where you want the references ==
65 65  
66 66  {{example}}
67 67  footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}}
... ... @@ -80,7 +80,7 @@
80 80  {{/example}}
81 81  
82 82  
83 -== Expandable Summary ==
108 +== Expandable Summary `/expandable`  VERY USEFUL MACRO ==
84 84  
85 85  {{example}}
86 86  {{expandable summary="🧠 Study Summary"}}
... ... @@ -108,21 +108,9 @@
108 108  {{/code}}
109 109  {{/example}}
110 110  
111 -== Audio Embedding ==
112 -
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}}
121 -
122 -This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
123 -
124 124  == ==
125 125  
138 +
126 126  == 📎 **Attachments and Images** ==
127 127  
128 128  You can easily upload files and images directly from the WYSIWYG editor:
... ... @@ -134,6 +134,19 @@
134 134  * Drag-and-drop or select your file to upload it instantly.
135 135  * Uploaded files will automatically be listed as attachments at the bottom of your page.
136 136  
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 +
137 137  === **Inserting Images with Enlargable Thumbnails** ===
138 138  
139 139  1. In the editor, click the **"Insert Image"** icon from the toolbar.
... ... @@ -142,25 +142,25 @@
142 142  
143 143  [[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]]
144 144  
145 -----
171 +== ==
146 146  
147 -== ⚡ **Using the / Macro Shortcut** ==
173 +(((
174 +=== **You can also use this format to insert images** ===
148 148  
149 -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}}
150 150  
151 -* Simply type / and start typing the macro name or feature you want to add.
152 -* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
153 -* Example macros include:
154 -** /toc – Table of Contents
155 -** /box – Insert Box Macro
156 -** /gallery – Image Gallery
157 -** /footnote – Add footnotes to your text
158 -** /code – Code blocks for programming snippets
180 +
181 +)))
159 159  
160 -This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax.
183 +{{code}}
184 + [[image:example.jpg]]
185 +{{/code}}
161 161  
162 -----
163 163  
188 +== ==
189 +
164 164  == ✏️** Basic Formatting and Links (Quick Guide)** ==
165 165  
166 166  * **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
... ... @@ -203,7 +203,6 @@
203 203  
204 204  * **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
205 205  * **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.
206 -* **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.
207 207  
208 208  == **Essential Formatting Options** ==
209 209  
... ... @@ -218,62 +218,6 @@
218 218  {{/code}}
219 219  
220 220  
221 -=== **Text Formatting** ===
222 -
223 -
224 -
225 -*
226 -** (((
227 -=== **Bold**: Surround text with double asterisks. ===
228 -)))
229 -
230 -{{code}}
231 -**bold text**
232 -{{/code}}
233 -
234 -
235 -*
236 -** (((
237 -=== **Italics**: Use double underscores. ===
238 -)))
239 -
240 -{{code}}
241 -__italic text__
242 -{{/code}}
243 -
244 -
245 -*
246 -** (((
247 -=== **Underline**: Enclose text with double tildes. ===
248 -)))
249 -
250 -{{code}}
251 -~~underlined text~~
252 -{{/code}}
253 -
254 -
255 -*
256 -** (((
257 -=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
258 -)))
259 -
260 -{{code}}
261 -* Item 1
262 -* Item 2
263 -{{/code}}
264 -
265 -
266 -*
267 -** (((
268 -=== **Ordered List**: Start lines with a number followed by a period. ===
269 -)))
270 -
271 -{{code}}
272 -1. First item
273 -2. Second item
274 -{{/code}}
275 -
276 -
277 277  == **Links** ==
278 278  
279 279  
... ... @@ -293,14 +293,9 @@
293 293  {{/code}}
294 294  
295 295  (((
296 -=== **Images** ===
265 +=== ===
297 297  )))
298 298  
299 -{{code}}
300 - [[image:example.jpg]]
301 -{{/code}}
302 -
303 -
304 304  == **Utilizing XWiki Macros** ==
305 305  
306 306  Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider: