0 Votes

Changes for page Start here if you're new

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

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