0 Votes

Changes for page Start here if you're new

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

From version 24.1
edited by Ryan C
on 2025/05/14 15:36
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,119 +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 ==
47 +XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:
60 60  
61 -footnote
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.
62 62  
63 -== Groovy Lookup ==
64 -{{example}}
65 -{{groovy}}
66 -def now = new Date()
67 -println("Current time: " + now)
68 -{{/groovy}}
69 -{{/example}}
52 +== **Essential Formatting Options** ==
70 70  
54 +To ensure content is both engaging and accessible, utilize the following formatting techniques:
71 71  
72 -== Expandable Summary ==
73 -{{example}}
74 -{{expandable summary="🧠 Study Summary"}}
75 -Key findings go here.
76 -{{/expandable}}
77 -{{/example}}
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.
78 78  
79 -== List Formatting ==
80 -{{example}}
81 -*Bad formatting*
82 -* use - inconsistently
83 -** Good formatting:
84 - * Consistent bullet style
85 - * Indented items properly
86 -{{/example}}
87 -
88 -== Python Code ==
89 -{{example}}
90 -{{code language="python"}}
91 -def greet():
92 - print("Hello World")
58 +{{code}}
59 + + Heading Level 1
60 + ++ Heading Level 2
61 + +++ Heading Level 3
93 93  {{/code}}
94 -{{/example}}
95 95  
96 -== Audio Embedding ==
97 -{{example}}
98 98  
99 -{{html}}
100 -<audio controls>
101 - <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
102 - Your browser does not support the audio element.
103 -</audio>
104 -{{/html}}
105 -{{/example}}
65 +== **Links** ==
106 106  
107 -This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
108 108  
109 -== ==
110 110  
111 -== 📎 **Attachments and Images** ==
69 +==== **Internal Link**: Use square brackets with the page name. ====
112 112  
113 -You can easily upload files and images directly from the WYSIWYG editor:
71 +{{code}}
72 +[[PageName]]
73 +{{/code}}
114 114  
115 -**Uploading Attachments:**
116 116  
117 -* Click **Edit** to enter the WYSIWYG editor.
118 -* Click on the **Attachment** icon (📎 paperclip icon).
119 -* Drag-and-drop or select your file to upload it instantly.
120 -* Uploaded files will automatically be listed as attachments at the bottom of your page.
121 121  
122 -=== **Inserting Images with Enlargable Thumbnails** ===
77 +==== **External Link**: Provide the URL directly. ====
123 123  
124 -1. In the editor, click the **"Insert Image"** icon from the toolbar.
125 -1. Upload or select the image.
126 -1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
79 +{{code}}
80 +[https://www.example.com]
81 +{{/code}}
127 127  
128 -----
83 +(((
84 +=== ===
85 +)))
129 129  
87 +
88 +== ==
89 +
130 130  == ⚡ **Using the / Macro Shortcut** ==
131 131  
132 132  The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
... ... @@ -140,150 +140,131 @@
140 140  ** /footnote – Add footnotes to your text
141 141  ** /code – Code blocks for programming snippets
142 142  
143 -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
144 144  
145 145  ----
146 146  
147 -== ✏️** Basic Formatting and Links (Quick Guide)** ==
107 +## 🧪 1. **Macro Showcase: Source-to-Output Toggle**##
148 148  
149 -* **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
150 -* **Italic text**: Select text, click "Italic" in the toolbar or use Ctrl+I.
151 -* **Creating Links**:
152 -** Highlight text and click **"Link"** or use shortcut Ctrl+K.
153 -** 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
154 154  
155 -----
156 156  
157 -== 🔍 **Useful Tips & Best Practices** ==
112 +=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
158 158  
159 -* **Save drafts frequently:** Press Ctrl+S regularly.
160 -* **Macros** greatly simplify content formatting—use / often.
161 -* **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them.
162 -* **Use minimal formatting** to ensure readability.
163 163  
164 -----
115 +{{code}}
116 +{{toc/}}
117 +{{/code}}
165 165  
166 -= ⚡**Guests can contribute** =
167 167  
168 -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.
169 -1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
170 -1. Leave comments, give suggestions, request features.
120 +== **Gallery Macro** `/gallery` ==
171 171  
172 -== **Content Guidelines** ==
122 +{{example}}
123 +{{gallery}}
124 +[[1747262485678-297.png]]
125 +[[image:photo2.jpg]]
126 +{{/gallery}}
127 +{{/example}}
173 173  
174 -* 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.
175 -* 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.
176 176  
177 -== **Directories and Page URLs** ==
130 +== **Alternatively** `/carousel` ==
178 178  
179 -* 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/}}
180 180  
135 +
136 +{{/example}}
181 181  
138 +== **Boilerplate Box** ==
182 182  
183 -== **XWiki Editing Modes** ==
140 +{{example}}
141 +{{box cssClass="highlight"}}
142 +Insert your highlighted content here.
143 +{{/box}}
144 +{{/example}}
184 184  
185 -XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:
146 +== ==
186 186  
187 -* **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
188 -* **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.
189 -* **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` ==
190 190  
191 -== **Essential Formatting Options** ==
150 +{{example}}
151 +{{info}}
152 +This is an info box.
153 +{{/info}}
192 192  
193 -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}}
194 194  
195 -* **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 ==
196 196  
197 -{{code}}
198 - + Heading Level 1
199 - ++ Heading Level 2
200 - +++ Heading Level 3
201 -{{/code}}
162 +{{example}}
163 +footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}}
202 202  
165 +{{putFootnotes/}}
166 +{{/example}}
203 203  
204 -=== **Text Formatting** ===
205 205  
169 +== ==
206 206  
171 +== **Expandable Summary** `/expandable`  VERY USEFUL MACRO ==
207 207  
208 -*
209 -** (((
210 -=== **Bold**: Surround text with double asterisks. ===
211 -)))
173 +{{example}}
174 +{{expandable summary="🧠 Study Summary"}}
175 +Key findings go here.
176 +{{/expandable}}
177 +{{/example}}
212 212  
213 -{{code}}
214 -**bold text**
215 -{{/code}}
179 +== ==
216 216  
181 +== 📎 **Attachments and Images** ==
217 217  
218 -*
219 -** (((
220 -=== **Italics**: Use double underscores. ===
221 -)))
183 +You can easily upload files and images directly from the WYSIWYG editor:
222 222  
223 -{{code}}
224 -__italic text__
225 -{{/code}}
185 +**Uploading Attachments:**
226 226  
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.
227 227  
228 -*
229 -** (((
230 -=== **Underline**: Enclose text with double tildes. ===
231 -)))
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` ==
232 232  
233 -{{code}}
234 -~~underlined text~~
235 -{{/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}}
236 236  
203 +This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
237 237  
238 -*
239 -** (((
240 -=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
241 -)))
205 +=== **Inserting Images with Enlargable Thumbnails** ===
242 242  
243 -{{code}}
244 -* Item 1
245 -* Item 2
246 -{{/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.
247 247  
211 +[[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]]
248 248  
249 -*
250 -** (((
251 -=== **Ordered List**: Start lines with a number followed by a period. ===
252 -)))
253 253  
254 -{{code}}
255 -1. First item
256 -2. Second item
257 -{{/code}}
258 258  
259 259  
260 -== **Links** ==
216 +=== **Alternatively: `~[~[image~:image.png]]`** ===
261 261  
218 +{{example}}
219 +[[image:1747262485678-297.png]]
220 +{{/example}}
262 262  
263 263  
264 -==== **Internal Link**: Use square brackets with the page name. ====
265 265  
266 -{{code}}
267 -[[PageName]]
268 -{{/code}}
224 +== ==
269 269  
226 +----
270 270  
271 -
272 -==== **External Link**: Provide the URL directly. ====
273 -
274 -{{code}}
275 -[https://www.example.com]
276 -{{/code}}
277 -
278 -(((
279 -=== **Images** ===
280 -)))
281 -
282 -{{code}}
283 - [[image:example.jpg]]
284 -{{/code}}
285 -
286 -
287 287  == **Utilizing XWiki Macros** ==
288 288  
289 289  Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
... ... @@ -306,18 +306,8 @@
306 306  {{/code}}
307 307  
308 308  
309 -== Footnote Macro ==
250 +== **Code Macro**: Renders code snippets with syntax highlighting. ==
310 310  
311 -The Footnote macro adds footnotes to the page.
312 -
313 -{{example}}
314 -This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
315 -{{putFootnotes/}}
316 -{{/example}}
317 -
318 -
319 -=== **Code Macro**: Renders code snippets with syntax highlighting. ===
320 -
321 321  {{code}}
322 322  {{code language="python"}}
323 323  def hello_world():
... ... @@ -326,26 +326,8 @@
326 326  {{/code}}
327 327  
328 328  
329 -=== **Gallery Macro**: Creates an image gallery from attached images. ===
260 +== **Video Macro**: `/video` The Video macro embeds videos. ==
330 330  
331 -{{code}}
332 -{{gallery}}
333 -[[image1.jpg]]
334 -[[image2.jpg]]
335 -{{/gallery}}
336 -{{/code}}
337 -
338 -
339 -=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
340 -
341 -{{code}}
342 -{{toc/}}
343 -{{/code}}
344 -
345 -== Video Macro ==
346 -
347 -The Video macro embeds videos.
348 -
349 349  {{example}}
350 350  {{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
351 351  {{/example}}
... ... @@ -354,12 +354,12 @@
354 354  == Example Macro ==
355 355  
356 356  The example macro displays the output of a macro or script or anything that you like
270 +
357 357  == Expandable Macro ==
358 358  
359 359  The following example demonstrates how to present complex information cleanly using `
360 360  
361 361  {{example}}
362 -
363 363  {{expandable summary="Study: The Wilson Effect: The Increase in Heritability of IQ With Age"}}
364 364  **Source:** *Twin Research and Human Genetics (Cambridge University Press)*
365 365  **Date of Publication:** *2013*
... ... @@ -429,4 +429,4 @@
429 429  {{/example}}
430 430  
431 431  
432 -
345 +
1747262485678-297.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.AdminAngriff
Size
... ... @@ -1,0 +1,1 @@
1 +1.6 MB
Content