0 Votes

Changes for page Start here if you're new

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

From version 27.1
edited by Ryan C
on 2025/05/14 15:40
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,23 +14,48 @@
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**##
20 20  
21 -Show how a macro works without cluttering the page with raw syntax.
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
22 22  
23 23  
24 -== Gallery Macro ==
41 +== Gallery Macro `/gallery` ==
25 25  
26 26  {{example}}
27 27  {{gallery}}
28 -[[image:photo1.jpg]]
45 +[[1747262485678-297.png]]
29 29  [[image:photo2.jpg]]
30 30  {{/gallery}}
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,8 @@
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 ==
90 +
65 65  {{example}}
66 66  footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}}
67 67  
... ... @@ -79,7 +79,7 @@
79 79  {{/example}}
80 80  
81 81  
82 -== Expandable Summary ==
108 +== Expandable Summary `/expandable`  VERY USEFUL MACRO ==
83 83  
84 84  {{example}}
85 85  {{expandable summary="🧠 Study Summary"}}
... ... @@ -107,21 +107,9 @@
107 107  {{/code}}
108 108  {{/example}}
109 109  
110 -== Audio Embedding ==
111 -
112 -{{example}}
113 -{{html}}
114 -<audio controls>
115 - <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
116 - Your browser does not support the audio element.
117 -</audio>
118 -{{/html}}
119 -{{/example}}
120 -
121 -This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
122 -
123 123  == ==
124 124  
138 +
125 125  == 📎 **Attachments and Images** ==
126 126  
127 127  You can easily upload files and images directly from the WYSIWYG editor:
... ... @@ -133,6 +133,19 @@
133 133  * Drag-and-drop or select your file to upload it instantly.
134 134  * Uploaded files will automatically be listed as attachments at the bottom of your page.
135 135  
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 +
136 136  === **Inserting Images with Enlargable Thumbnails** ===
137 137  
138 138  1. In the editor, click the **"Insert Image"** icon from the toolbar.
... ... @@ -139,25 +139,27 @@
139 139  1. Upload or select the image.
140 140  1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
141 141  
142 -----
169 +[[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]]
143 143  
144 -== **Using the / Macro Shortcut** ==
171 +== ==
145 145  
146 -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** ===
147 147  
148 -* Simply type / and start typing the macro name or feature you want to add.
149 -* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
150 -* Example macros include:
151 -** /toc – Table of Contents
152 -** /box – Insert Box Macro
153 -** /gallery – Image Gallery
154 -** /footnote – Add footnotes to your text
155 -** /code – Code blocks for programming snippets
176 +{{example}}
177 +~[~[image~:1747262485678-297.png]]
178 +{{/example}}
156 156  
157 -This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax.
180 +
181 +)))
158 158  
159 -----
183 +{{code}}
184 + [[image:example.jpg]]
185 +{{/code}}
160 160  
187 +
188 +== ==
189 +
161 161  == ✏️** Basic Formatting and Links (Quick Guide)** ==
162 162  
163 163  * **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
... ... @@ -200,7 +200,6 @@
200 200  
201 201  * **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
202 202  * **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.
203 -* **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.
204 204  
205 205  == **Essential Formatting Options** ==
206 206  
... ... @@ -215,62 +215,6 @@
215 215  {{/code}}
216 216  
217 217  
218 -=== **Text Formatting** ===
219 -
220 -
221 -
222 -*
223 -** (((
224 -=== **Bold**: Surround text with double asterisks. ===
225 -)))
226 -
227 -{{code}}
228 -**bold text**
229 -{{/code}}
230 -
231 -
232 -*
233 -** (((
234 -=== **Italics**: Use double underscores. ===
235 -)))
236 -
237 -{{code}}
238 -__italic text__
239 -{{/code}}
240 -
241 -
242 -*
243 -** (((
244 -=== **Underline**: Enclose text with double tildes. ===
245 -)))
246 -
247 -{{code}}
248 -~~underlined text~~
249 -{{/code}}
250 -
251 -
252 -*
253 -** (((
254 -=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
255 -)))
256 -
257 -{{code}}
258 -* Item 1
259 -* Item 2
260 -{{/code}}
261 -
262 -
263 -*
264 -** (((
265 -=== **Ordered List**: Start lines with a number followed by a period. ===
266 -)))
267 -
268 -{{code}}
269 -1. First item
270 -2. Second item
271 -{{/code}}
272 -
273 -
274 274  == **Links** ==
275 275  
276 276  
... ... @@ -290,14 +290,9 @@
290 290  {{/code}}
291 291  
292 292  (((
293 -=== **Images** ===
265 +=== ===
294 294  )))
295 295  
296 -{{code}}
297 - [[image:example.jpg]]
298 -{{/code}}
299 -
300 -
301 301  == **Utilizing XWiki Macros** ==
302 302  
303 303  Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
1747262485678-297.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.AdminAngriff
Size
... ... @@ -1,0 +1,1 @@
1 +1.6 MB
Content