0 Votes

Changes for page Start here if you're new

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

From version 23.1
edited by Ryan C
on 2025/05/14 15:33
Change comment: There is no comment for this version
To version 34.1
edited by Ryan C
on 2025/05/14 16:06
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -14,128 +14,79 @@
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 18  
19 -## 🧪 1. **Macro Showcase: Source-to-Output Toggle**
20 20  
21 -Show how a macro works without cluttering the page with raw syntax.
19 +== 🔍 **Useful Tips & Best Practices** ==
22 22  
21 +* **Save drafts frequently:** Press Ctrl+S regularly.
22 +* **Macros** greatly simplify content formatting—use / often.
23 +* **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them.
24 +* **Use minimal formatting** to ensure readability.
23 23  
24 -== Gallery Macro ==
26 +----
25 25  
26 -{{example}}
28 += ⚡**Guests can contribute** =
27 27  
28 -{{gallery}}
29 -[[image:photo1.jpg]]
30 -[[image:photo2.jpg]]
31 -{{/gallery}}
30 +1. Guests can edit pages in the main content area without signing up. If this becomes problematic I'll change it but for now I'd like everyone to have access with as little trouble as possible.
31 +1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
32 +1. Leave comments, give suggestions, request features.
32 32  
33 -{{/example}}
34 +== **Content Guidelines** ==
34 34  
36 +* Ensure your content is well-researched, you don't need to include references in the format of footnotes for your material, but you should try to include studies or links to give credibility to your claims. For instance, just claiming that [[IQ is genetic>>doc:Main Categories.Science & Research.Race & IQ.WebHome]] is genetic wouldn't be valid unless you provide a study backing up that assertion, or more likely link to a page within this site that explains why IQ is not something that is purely determined by environmental factors. If such a page doesn't exist, create it, and start providing studies that show this.
37 +* Use clear, concise language and avoid using slurs, slang, or troll like language. This isn't supposed to be encyclopedia dramatica, I'd like things to remain relatively mature and well thought out.
35 35  
36 -== Boilerplate Box ==
37 -{{example}}
38 -{{box cssClass="highlight"}}
39 -Insert your highlighted content here.
40 -{{/box}}
41 -{{/example}}
39 +== **Directories and Page URLs** ==
42 42  
43 -== Velocity Greeting ==
44 -{{example}}
45 -{{velocity}}
46 -#set($name = "Visitor")
47 -Hello, $name!
48 -{{/velocity}}
49 -{{/example}}
41 +* The categories I have made up should cover most content, but if you feel your content doesn't fit under them, feel free to make a new category. Moving pages and reorganizing content in this wiki is very easy.
50 50  
51 51  
52 -== Info vs Warning ==
53 -{{example}}
54 -{{info}}This is an info box.{{/info}}
55 55  
56 -{{warning}}This is a warning box.{{/warning}}
57 -{{/example}}
45 +== **XWiki Editing Modes** ==
58 58  
59 -== Footnote Demo ==
60 -{{example}}
61 -This claim needs a source{{footnote}}Here it is.{{/footnote}}.
62 -{{putFootnotes/}}
63 -{{/example}}
47 +XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:
64 64  
65 -== Groovy Lookup ==
66 -{{example}}
67 -{{groovy}}
68 -def now = new Date()
69 -println("Current time: " + now)
70 -{{/groovy}}
71 -{{/example}}
49 +* **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
50 +* **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.
72 72  
52 +== **Essential Formatting Options** ==
73 73  
74 -== Access Current User ==
75 -{{example}}
76 -{{velocity}}
77 -Current user: **$xcontext.user**
78 -{{/velocity}}
79 -{{/example}}
54 +To ensure content is both engaging and accessible, utilize the following formatting techniques:
80 80  
56 +* **Headings**: Organize content hierarchically using headings. In XWiki syntax, headings are defined by one to six plus signs (+), corresponding to heading levels 1 to 6.
81 81  
82 -== Expandable Summary ==
83 -{{example}}
84 -{{expandable summary="🧠 Study Summary"}}
85 -Key findings go here.
86 -{{/expandable}}
87 -{{/example}}
58 +{{code}}
59 + + Heading Level 1
60 + ++ Heading Level 2
61 + +++ Heading Level 3
62 +{{/code}}
88 88  
89 -== List Formatting ==
90 -{{example}}
91 -*Bad formatting*
92 -* use - inconsistently
93 -** Good formatting:
94 - * Consistent bullet style
95 - * Indented items properly
96 -{{/example}}
97 97  
98 -== Python Code ==
99 -{{example}}
100 -{{code language="python"}}
101 -def greet():
102 - print("Hello World")
103 -{{/code}}
104 -{{/example}}
65 +== **Links** ==
105 105  
106 -== Audio Embedding ==
107 -{{example}}
108 -{{html}}
109 -<audio controls>
110 - <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
111 - Your browser does not support the audio element.
112 -</audio>
113 -{{/html}}
114 -{{/example}}
115 -
116 -This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
117 117  
118 -== ==
119 119  
120 -== 📎 **Attachments and Images** ==
69 +==== **Internal Link**: Use square brackets with the page name. ====
121 121  
122 -You can easily upload files and images directly from the WYSIWYG editor:
71 +{{code}}
72 +[[PageName]]
73 +{{/code}}
123 123  
124 -**Uploading Attachments:**
125 125  
126 -* Click **Edit** to enter the WYSIWYG editor.
127 -* Click on the **Attachment** icon (📎 paperclip icon).
128 -* Drag-and-drop or select your file to upload it instantly.
129 -* Uploaded files will automatically be listed as attachments at the bottom of your page.
130 130  
131 -=== **Inserting Images with Enlargable Thumbnails** ===
77 +==== **External Link**: Provide the URL directly. ====
132 132  
133 -1. In the editor, click the **"Insert Image"** icon from the toolbar.
134 -1. Upload or select the image.
135 -1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
79 +{{code}}
80 +[https://www.example.com]
81 +{{/code}}
136 136  
137 -----
83 +(((
84 +=== ===
85 +)))
138 138  
87 +
88 +== ==
89 +
139 139  == ⚡ **Using the / Macro Shortcut** ==
140 140  
141 141  The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
... ... @@ -149,150 +149,131 @@
149 149  ** /footnote – Add footnotes to your text
150 150  ** /code – Code blocks for programming snippets
151 151  
152 -This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax.
103 +This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax
153 153  
154 154  ----
155 155  
156 -== ✏️** Basic Formatting and Links (Quick Guide)** ==
107 +## 🧪 1. **Macro Showcase: Source-to-Output Toggle**##
157 157  
158 -* **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
159 -* **Italic text**: Select text, click "Italic" in the toolbar or use Ctrl+I.
160 -* **Creating Links**:
161 -** Highlight text and click **"Link"** or use shortcut Ctrl+K.
162 -** Paste or select the page URL to link internally.
109 +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
163 163  
164 -----
165 165  
166 -== 🔍 **Useful Tips & Best Practices** ==
112 +=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
167 167  
168 -* **Save drafts frequently:** Press Ctrl+S regularly.
169 -* **Macros** greatly simplify content formatting—use / often.
170 -* **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them.
171 -* **Use minimal formatting** to ensure readability.
172 172  
173 -----
115 +{{code}}
116 +{{toc/}}
117 +{{/code}}
174 174  
175 -= ⚡**Guests can contribute** =
176 176  
177 -1. Guests can edit pages in the main content area without signing up. If this becomes problematic I'll change it but for now I'd like everyone to have access with as little trouble as possible.
178 -1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
179 -1. Leave comments, give suggestions, request features.
120 +== **Gallery Macro** `/gallery` ==
180 180  
181 -== **Content Guidelines** ==
122 +{{example}}
123 +{{gallery}}
124 +[[1747262485678-297.png]]
125 +[[image:photo2.jpg]]
126 +{{/gallery}}
127 +{{/example}}
182 182  
183 -* Ensure your content is well-researched, you don't need to include references in the format of footnotes for your material, but you should try to include studies or links to give credibility to your claims. For instance, just claiming that [[IQ is genetic>>doc:Main Categories.Science & Research.Race & IQ.WebHome]] is genetic wouldn't be valid unless you provide a study backing up that assertion, or more likely link to a page within this site that explains why IQ is not something that is purely determined by environmental factors. If such a page doesn't exist, create it, and start providing studies that show this.
184 -* Use clear, concise language and avoid using slurs, slang, or troll like language. This isn't supposed to be encyclopedia dramatica, I'd like things to remain relatively mature and well thought out.
185 185  
186 -== **Directories and Page URLs** ==
130 +== **Alternatively** `/carousel` ==
187 187  
188 -* The categories I have made up should cover most content, but if you feel your content doesn't fit under them, feel free to make a new category. Moving pages and reorganizing content in this wiki is very easy.
132 +{{example}}
133 +{{carousel/}}
189 189  
135 +
136 +{{/example}}
190 190  
138 +== **Boilerplate Box** ==
191 191  
192 -== **XWiki Editing Modes** ==
140 +{{example}}
141 +{{box cssClass="highlight"}}
142 +Insert your highlighted content here.
143 +{{/box}}
144 +{{/example}}
193 193  
194 -XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:
146 +== ==
195 195  
196 -* **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
197 -* **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.
198 -* **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.
148 +== **Info vs Warning **`/info box` ==
199 199  
200 -== **Essential Formatting Options** ==
150 +{{example}}
151 +{{info}}
152 +This is an info box.
153 +{{/info}}
201 201  
202 -To ensure content is both engaging and accessible, utilize the following formatting techniques:
155 +{{warning}}
156 +This is a warning box.
157 +{{/warning}}
158 +{{/example}}
203 203  
204 -* **Headings**: Organize content hierarchically using headings. In XWiki syntax, headings are defined by one to six plus signs (+), corresponding to heading levels 1 to 6.
160 +== **Footnote Demo** `/footnote and /put footnotes` put the put footnotes macro at the bottom where you want the references ==
205 205  
206 -{{code}}
207 - + Heading Level 1
208 - ++ Heading Level 2
209 - +++ Heading Level 3
210 -{{/code}}
162 +{{example}}
163 +footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}}
211 211  
165 +{{putFootnotes/}}
166 +{{/example}}
212 212  
213 -=== **Text Formatting** ===
214 214  
169 +== ==
215 215  
171 +== **Expandable Summary** `/expandable`  VERY USEFUL MACRO ==
216 216  
217 -*
218 -** (((
219 -=== **Bold**: Surround text with double asterisks. ===
220 -)))
173 +{{example}}
174 +{{expandable summary="🧠 Study Summary"}}
175 +Key findings go here.
176 +{{/expandable}}
177 +{{/example}}
221 221  
222 -{{code}}
223 -**bold text**
224 -{{/code}}
179 +== ==
225 225  
181 +== 📎 **Attachments and Images** ==
226 226  
227 -*
228 -** (((
229 -=== **Italics**: Use double underscores. ===
230 -)))
183 +You can easily upload files and images directly from the WYSIWYG editor:
231 231  
232 -{{code}}
233 -__italic text__
234 -{{/code}}
185 +**Uploading Attachments:**
235 235  
187 +* Click **Edit** to enter the WYSIWYG editor.
188 +* Click on the **Attachment** icon (📎 paperclip icon).
189 +* Drag-and-drop or select your file to upload it instantly.
190 +* Uploaded files will automatically be listed as attachments at the bottom of your page.
236 236  
237 -*
238 -** (((
239 -=== **Underline**: Enclose text with double tildes. ===
240 -)))
192 +== **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` ==
241 241  
242 -{{code}}
243 -~~underlined text~~
244 -{{/code}}
194 +{{example}}
195 +{{html}}
196 +<audio controls>
197 + <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
198 + Your browser does not support the audio element.
199 +</audio>
200 +{{/html}}
201 +{{/example}}
245 245  
203 +This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
246 246  
247 -*
248 -** (((
249 -=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
250 -)))
205 +=== **Inserting Images with Enlargable Thumbnails** ===
251 251  
252 -{{code}}
253 -* Item 1
254 -* Item 2
255 -{{/code}}
207 +1. In the editor, click the **"Insert Image"** icon from the toolbar.
208 +1. Upload or select the image.
209 +1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
256 256  
211 +[[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]]
257 257  
258 -*
259 -** (((
260 -=== **Ordered List**: Start lines with a number followed by a period. ===
261 -)))
262 262  
263 -{{code}}
264 -1. First item
265 -2. Second item
266 -{{/code}}
267 267  
268 268  
269 -== **Links** ==
216 +=== **Alternatively: `~[~[image~:image.png]]`** ===
270 270  
218 +{{example}}
219 +[[image:1747262485678-297.png]]
220 +{{/example}}
271 271  
272 272  
273 -==== **Internal Link**: Use square brackets with the page name. ====
274 274  
275 -{{code}}
276 -[[PageName]]
277 -{{/code}}
224 +== ==
278 278  
226 +----
279 279  
280 -
281 -==== **External Link**: Provide the URL directly. ====
282 -
283 -{{code}}
284 -[https://www.example.com]
285 -{{/code}}
286 -
287 -(((
288 -=== **Images** ===
289 -)))
290 -
291 -{{code}}
292 - [[image:example.jpg]]
293 -{{/code}}
294 -
295 -
296 296  == **Utilizing XWiki Macros** ==
297 297  
298 298  Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
... ... @@ -315,18 +315,8 @@
315 315  {{/code}}
316 316  
317 317  
318 -== Footnote Macro ==
250 +== **Code Macro**: Renders code snippets with syntax highlighting. ==
319 319  
320 -The Footnote macro adds footnotes to the page.
321 -
322 -{{example}}
323 -This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
324 -{{putFootnotes/}}
325 -{{/example}}
326 -
327 -
328 -=== **Code Macro**: Renders code snippets with syntax highlighting. ===
329 -
330 330  {{code}}
331 331  {{code language="python"}}
332 332  def hello_world():
... ... @@ -335,26 +335,8 @@
335 335  {{/code}}
336 336  
337 337  
338 -=== **Gallery Macro**: Creates an image gallery from attached images. ===
260 +== **Video Macro**: `/video` The Video macro embeds videos. ==
339 339  
340 -{{code}}
341 -{{gallery}}
342 -[[image1.jpg]]
343 -[[image2.jpg]]
344 -{{/gallery}}
345 -{{/code}}
346 -
347 -
348 -=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
349 -
350 -{{code}}
351 -{{toc/}}
352 -{{/code}}
353 -
354 -== Video Macro ==
355 -
356 -The Video macro embeds videos.
357 -
358 358  {{example}}
359 359  {{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
360 360  {{/example}}
... ... @@ -363,12 +363,12 @@
363 363  == Example Macro ==
364 364  
365 365  The example macro displays the output of a macro or script or anything that you like
270 +
366 366  == Expandable Macro ==
367 367  
368 368  The following example demonstrates how to present complex information cleanly using `
369 369  
370 370  {{example}}
371 -
372 372  {{expandable summary="Study: The Wilson Effect: The Increase in Heritability of IQ With Age"}}
373 373  **Source:** *Twin Research and Human Genetics (Cambridge University Press)*
374 374  **Date of Publication:** *2013*
... ... @@ -438,4 +438,4 @@
438 438  {{/example}}
439 439  
440 440  
441 -
345 +
1747262485678-297.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.AdminAngriff
Size
... ... @@ -1,0 +1,1 @@
1 +1.6 MB
Content