0 Votes

Changes for page Start here if you're new

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

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