0 Votes

Changes for page Start here if you're new

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

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