0 Votes

Changes for page Start here if you're new

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

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