... |
... |
@@ -14,23 +14,6 @@ |
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 |
|
- |
34 |
34 |
---- |
35 |
35 |
|
36 |
36 |
## 🧪 1. **Macro Showcase: Source-to-Output Toggle**## |
... |
... |
@@ -47,9 +47,9 @@ |
47 |
47 |
{{/gallery}} |
48 |
48 |
{{/example}} |
49 |
49 |
|
|
33 |
+Alternatively |
|
34 |
+\\ |
50 |
50 |
|
51 |
|
-== Alternatively `/carousel` == |
52 |
|
- |
53 |
53 |
{{example}} |
54 |
54 |
{{carousel/}} |
55 |
55 |
|
... |
... |
@@ -74,7 +74,7 @@ |
74 |
74 |
{{/example}} |
75 |
75 |
|
76 |
76 |
|
77 |
|
-== Info vs Warning `/info box` == |
|
60 |
+== Info vs Warning == |
78 |
78 |
|
79 |
79 |
{{example}} |
80 |
80 |
{{info}} |
... |
... |
@@ -86,7 +86,7 @@ |
86 |
86 |
{{/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 == |
|
72 |
+== Footnote Demo == |
90 |
90 |
|
91 |
91 |
{{example}} |
92 |
92 |
footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}} |
... |
... |
@@ -105,7 +105,7 @@ |
105 |
105 |
{{/example}} |
106 |
106 |
|
107 |
107 |
|
108 |
|
-== Expandable Summary `/expandable` VERY USEFUL MACRO == |
|
91 |
+== Expandable Summary == |
109 |
109 |
|
110 |
110 |
{{example}} |
111 |
111 |
{{expandable summary="🧠 Study Summary"}} |
... |
... |
@@ -133,9 +133,21 @@ |
133 |
133 |
{{/code}} |
134 |
134 |
{{/example}} |
135 |
135 |
|
136 |
|
-== == |
|
119 |
+== Audio Embedding == |
137 |
137 |
|
|
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}} |
138 |
138 |
|
|
130 |
+This page covers all the essential steps and tips you need to create great content in XWiki without any confusion. |
|
131 |
+ |
|
132 |
+== == |
|
133 |
+ |
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. |
... |
... |
@@ -168,25 +168,25 @@ |
168 |
168 |
|
169 |
169 |
[[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]] |
170 |
170 |
|
171 |
|
-== == |
|
153 |
+---- |
172 |
172 |
|
173 |
|
-((( |
174 |
|
-=== **You can also use this format to insert images** === |
|
155 |
+== ⚡ **Using the / Macro Shortcut** == |
175 |
175 |
|
176 |
|
-{{example}} |
177 |
|
-~[~[image~:1747262485678-297.png]] |
178 |
|
-{{/example}} |
|
157 |
+The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor: |
179 |
179 |
|
180 |
|
- |
181 |
|
-))) |
|
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 |
182 |
182 |
|
183 |
|
-{{code}} |
184 |
|
- [[image:example.jpg]] |
185 |
|
-{{/code}} |
|
168 |
+This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax. |
186 |
186 |
|
|
170 |
+---- |
187 |
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. citeturn0search0 |
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. |
|
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. |
232 |
232 |
|
233 |
233 |
== **Essential Formatting Options** == |
234 |
234 |
|
... |
... |
@@ -243,6 +243,62 @@ |
243 |
243 |
{{/code}} |
244 |
244 |
|
245 |
245 |
|
|
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 |
+ |
246 |
246 |
== **Links** == |
247 |
247 |
|
248 |
248 |
|
... |
... |
@@ -262,9 +262,14 @@ |
262 |
262 |
{{/code}} |
263 |
263 |
|
264 |
264 |
((( |
265 |
|
-=== === |
|
304 |
+=== **Images** === |
266 |
266 |
))) |
267 |
267 |
|
|
307 |
+{{code}} |
|
308 |
+ [[image:example.jpg]] |
|
309 |
+{{/code}} |
|
310 |
+ |
|
311 |
+ |
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: |