0 Votes

Changes for page Start here if you're new

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

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