0 Votes

Changes for page Start here if you're new

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

From version 15.1
edited by Ryan C
on 2025/05/14 13:29
Change comment: There is no comment for this version
To version 35.1
edited by Ryan C
on 2025/05/14 16:18
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,309 +1,204 @@
1 -= =
1 += πŸ“š Macro Examples & Formatting Guide =
2 2  
3 3  ----
4 4  
5 -== ==
5 +== πŸ“– Table of Contents ==
6 6  
7 -== πŸ“– Table of Contents: ==
8 -
9 9  {{toc/}}
10 10  
11 11  ----
12 12  
13 -== Getting Started with XWiki ==
11 +== πŸ§ͺ Macro Showcase: Source + Output + Slash Command ==
14 14  
15 -This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
13 +All macros are shown with the WYSIWYG `/command`, an expandable explanation, and an editable source/output block using example
16 16  
17 -== ==
15 +----
18 18  
19 -== πŸ“Ž **Attachments and Images** ==
17 +== Table of Contents Macro (`/toc`) ==
20 20  
21 -You can easily upload files and images directly from the WYSIWYG editor:
19 +{{expandable summary="πŸ“˜ Table of Contents Macro (`/toc`)"}}
20 +{{example}}
21 +{{toc/}}
22 +{{/example}}
23 +{{/expandable}}
22 22  
23 -**Uploading Attachments:**
24 -
25 -* Click **Edit** to enter the WYSIWYG editor.
26 -* Click on the **Attachment** icon (πŸ“Ž paperclip icon).
27 -* Drag-and-drop or select your file to upload it instantly.
28 -* Uploaded files will automatically be listed as attachments at the bottom of your page.
29 -
30 -=== **Inserting Images with Enlargable Thumbnails** ===
31 -
32 -1. In the editor, click the **"Insert Image"** icon from the toolbar.
33 -1. Upload or select the image.
34 -1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
35 -
36 36  ----
37 37  
38 -== ⚑ **Using the / Macro Shortcut** ==
27 +== Gallery Macro (`/gallery`) ==
39 39  
40 -The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
29 +{{expandable summary="πŸ–ΌοΈ Gallery Macro (`/gallery`)"}}
30 +{{example}}
31 +{{gallery}}
32 +[[1747262485678-297.png]]
33 +[[image:photo2.jpg]]
34 +{{/gallery}}
35 +{{/example}}
36 +{{/expandable}}
41 41  
42 -* Simply type / and start typing the macro name or feature you want to add.
43 -* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
44 -* Example macros include:
45 -** /toc – Table of Contents
46 -** /box – Insert Box Macro
47 -** /gallery – Image Gallery
48 -** /footnote – Add footnotes to your text
49 -** /code – Code blocks for programming snippets
50 -
51 -This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax.
52 -
53 53  ----
54 54  
55 -== ✏️** Basic Formatting and Links (Quick Guide)** ==
40 +== Carousel Macro (`/carousel`) ==
56 56  
57 -* **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
58 -* **Italic text**: Select text, click "Italic" in the toolbar or use Ctrl+I.
59 -* **Creating Links**:
60 -** Highlight text and click **"Link"** or use shortcut Ctrl+K.
61 -** Paste or select the page URL to link internally.
42 +{{expandable summary="πŸ“½οΈ Carousel Macro (`/carousel`)"}}
43 +{{example}}
44 +{{carousel/}}
45 +{{/example}}
46 +{{/expandable}}
62 62  
63 63  ----
64 64  
65 -== πŸ” **Useful Tips & Best Practices** ==
50 +== Box Macro (`/box`) ==
66 66  
67 -* **Save drafts frequently:** Press Ctrl+S regularly.
68 -* **Macros** greatly simplify content formattingβ€”use / often.
69 -* **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them.
70 -* **Use minimal formatting** to ensure readability.
52 +{{expandable summary="πŸ“¦ Box Macro (`/box`)"}}
53 +{{example}}
54 +{{box cssClass="highlight"}}
55 +Insert your highlighted content here.
56 +{{/box}}
57 +{{/example}}
58 +{{/expandable}}
71 71  
72 72  ----
73 73  
74 -= ⚑**Guests can contribute** =
62 +== Info and Warning Boxes (`/info`, `/warning`) ==
75 75  
76 -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.
77 -1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
78 -1. Leave comments, give suggestions, request features.
64 +{{expandable summary="⚠️ Info and Warning Macros (`/info`, `/warning`)"}}
65 +{{example}}
66 +{{info}}This is an info box.{{/info}}
79 79  
80 -== **Content Guidelines** ==
68 +{{warning}}This is a warning box.{{/warning}}
69 +{{/example}}
70 +{{/expandable}}
81 81  
82 -* 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.
83 -* 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.
72 +----
84 84  
85 -== **Directories and Page URLs** ==
74 +== Footnotes (`/footnote`, `/put footnotes`) ==
86 86  
87 -* 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.
76 +{{expandable summary="🧾 Footnote + PutFootnotes (`/footnote`, `/put footnotes`)"}}
77 +{{example}}
78 +This is a footnoted statement{{footnote}}https://www.example.com{{/footnote}}.
88 88  
80 +{{putFootnotes/}}
81 +{{/example}}
82 +{{/expandable}}
89 89  
84 +----
90 90  
91 -== **XWiki Editing Modes** ==
86 +== Expandable Macro (`/expandable`) ==
92 92  
93 -XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:ξˆ†
94 -
95 -* **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ξˆξˆ†
96 -* **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.ξˆ†
97 -* **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.ξˆ†
98 -
99 -== **Essential Formatting Options** ==
100 -
101 -To ensure content is both engaging and accessible, utilize the following formatting techniques:ξˆ†
102 -
103 -* **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.ξˆ†
104 -
105 -{{code}}
106 - + Heading Level 1
107 - ++ Heading Level 2
108 - +++ Heading Level 3
109 -{{/code}}
110 -
111 -
112 -=== **Text Formatting** ===
113 -
114 -
115 -
116 -*
117 -** (((
118 -=== **Bold**: Surround text with double asterisks. ===
119 -)))
120 -
121 -{{code}}
122 -**bold text**
123 -{{/code}}
124 -
125 -
126 -*
127 -** (((
128 -=== **Italics**: Use double underscores. ===
129 -)))
130 -
131 -{{code}}
132 -__italic text__
133 -{{/code}}
134 -
135 -
136 -*
137 -** (((
138 -=== **Underline**: Enclose text with double tildes. ===
139 -)))
140 -
141 -{{code}}
142 -~~underlined text~~
143 -{{/code}}
144 -
145 -
146 -*
147 -** (((
148 -=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
149 -)))
150 -
151 -{{code}}
152 -* Item 1
153 -* Item 2
154 -{{/code}}
155 -
156 -
157 -*
158 -** (((
159 -=== **Ordered List**: Start lines with a number followed by a period. ===
160 -)))
161 -
162 -{{code}}
163 -1. First item
164 -2. Second item
165 -{{/code}}
166 -
167 -
168 -== **Links** ==
169 -
170 -
171 -
172 -==== **Internal Link**: Use square brackets with the page name. ====
173 -
174 -{{code}}
175 -[[PageName]]
176 -{{/code}}
177 -
178 -
179 -
180 -==== **External Link**: Provide the URL directly. ====
181 -
182 -{{code}}
183 -[https://www.example.com]
184 -{{/code}}
185 -
186 -(((
187 -=== **Images** ===
188 -)))
189 -
190 -{{code}}
191 - [[image:example.jpg]]
192 -{{/code}}
193 -
194 -
195 -== **Utilizing XWiki Macros** ==
196 -
197 -Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:ξˆ†
198 -
199 -== Embed Macro ==
200 -
201 -The Embed macro shows external content like YouTube videos.
202 -
88 +{{expandable summary="🧩 Expandable Macro (`/expandable`)"}}
203 203  {{example}}
204 -{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
90 +{{expandable summary="Click to expand"}}
91 +This content is hidden until clicked.
92 +{{/expandable}}
205 205  {{/example}}
94 +{{/expandable}}
206 206  
96 +----
207 207  
208 -=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
98 +== Embed Macro (`/embed content`) ==
209 209  
210 -{{code}}
211 -{{info}}
212 -This is an informational note.
213 -{{/info}}
214 -{{/code}}
215 -
216 -
217 -== Footnote Macro ==
218 -
219 -The Footnote macro adds footnotes to the page.
220 -
100 +{{expandable summary="🌐 Embed Macro (YouTube etc.) (`/embed content`)"}}
221 221  {{example}}
222 -This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
223 -{{putFootnotes/}}
102 +{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
224 224  {{/example}}
104 +{{/expandable}}
225 225  
106 +----
226 226  
227 -=== **Code Macro**: Renders code snippets with syntax highlighting. ===
108 +== Code Macro (`/code`) ==
228 228  
229 -{{code}}
110 +{{expandable summary="πŸ’» Code Block Macro (`/code`)"}}
111 +{{example}}
230 230  {{code language="python"}}
231 231  def hello_world():
232 232   print("Hello, world!")
233 233  {{/code}}
234 -{{/code}}
116 +{{/example}}
117 +{{/expandable}}
235 235  
119 +----
236 236  
237 -=== **Gallery Macro**: Creates an image gallery from attached images. ===
121 +== Image Insert (`[[image:...]]`) ==
238 238  
239 -{{code}}
240 -{{gallery}}
241 -[[image1.jpg]]
242 -[[image2.jpg]]
243 -{{/gallery}}
244 -{{/code}}
123 +{{expandable summary="πŸ–ΌοΈ Image Macro (`[[image:filename.jpg]]`)"}}
124 +{{example}}
125 +[[image:1747262485678-297.png]]
126 +{{/example}}
127 +{{/expandable}}
245 245  
129 +----
246 246  
247 -=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
131 +== Audio Embed (HTML tag or `/embed JWPlayer`) ==
248 248  
249 -{{code}}
250 -{{toc/}}
251 -{{/code}}
133 +{{expandable summary="πŸ”Š Audio Embed (`<audio>` tag or `/embed JWPlayer`)"}}
134 +{{example}}
135 +{{html}}
136 +<audio controls>
137 + <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
138 + Your browser does not support the audio element.
139 +</audio>
140 +{{/html}}
141 +{{/example}}
142 +{{/expandable}}
252 252  
253 -== Video Macro ==
144 +----
254 254  
255 -The Video macro embeds videos.
146 +== Video Embed Macro (`/video`) ==
256 256  
148 +{{expandable summary="🎬 Video Macro (`/video`)"}}
257 257  {{example}}
258 258  {{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
259 259  {{/example}}
152 +{{/expandable}}
260 260  
261 -== Expandable Macro ==
262 -The following example demonstrates how to present complex information cleanly using `{{expandable}}` and `{{example}}`.
154 +----
263 263  
156 +== Full Example: Expandable Study Summary (`/expandable`) ==
157 +
158 +{{expandable summary="πŸ“š Full Use Case – Study Summary Macro (`/expandable`)"}}
264 264  {{example}}
265 -{{expandable summary="🧠 Study: Survey of Expert Opinion on Intelligence"}}
266 -**Source:** *Intelligence (Elsevier)*
267 -**Date:** *2019*
268 -**Authors:** *Heiner Rindermann, David Becker, Thomas R. Coyle*
269 -**DOI:** [10.1016/j.intell.2019.101406](https://doi.org/10.1016/j.intell.2019.101406)
270 -**Subject:** *Psychology, Intelligence Research*
160 +{{expandable summary="Study: The Wilson Effect"}}
161 +**Source:** *Twin Research and Human Genetics (2013)*
162 +**Author:** *Thomas J. Bouchard Jr.*
163 +**DOI:** [10.1017/thg.2013.54](https://doi.org/10.1017/thg.2013.54)
271 271  
272 272  {{expandable summary="πŸ“Š Key Statistics"}}
273 -- Survey of **102 intelligence experts**
274 -- **90% from Western countries**, **83% male**
275 -- **54% left-liberal**, **24% conservative**
276 -- **50/50 split** on genetic vs environmental causes of Black-White IQ gap
166 +- IQ heritability rises to **0.80** by adulthood
167 +- Shared environment drops to **0.10**
277 277  {{/expandable}}
278 278  
279 279  {{expandable summary="πŸ”¬ Findings"}}
280 -- Support for **g-factor theory**
281 -- Agreement on **heritability of intelligence**
282 -- Political lean: left = environmental, right = genetic causes
171 +- Genetic influence strengthens over time
172 +- Monozygotic twins’ IQ similarity increases with age
283 283  {{/expandable}}
284 284  
285 -{{expandable summary="πŸ“ Critique"}}
286 -- Largest expert survey on intelligence
287 -- **Western-only sample**, possible **self-selection bias**
175 +{{expandable summary="πŸ“ Critique & Observations"}}
176 +- Strength: Large dataset, longitudinal
177 +- Limitation: Mostly Western countries
288 288  {{/expandable}}
289 289  
290 290  {{expandable summary="πŸ“Œ Relevance"}}
291 -- Shows **ideological divide** in science
292 -- Highlights **media vs expert disconnect**
181 +- Strong support for genetic IQ theories
182 +- Diminishing environmental influence
293 293  {{/expandable}}
294 294  
295 -{{expandable summary="πŸ” Explore More"}}
296 -- Global surveys on intelligence beliefs
297 -- Media analysis follow-up studies
185 +{{expandable summary="πŸ“„ Download"}}
186 +[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
298 298  {{/expandable}}
299 299  
300 -{{expandable summary="πŸ“„ Download"}}
301 -[[Download Study>>attach:10.1016_j.intell.2019.101406.pdf]]
302 302  {{/expandable}}
303 -{{/expandable}}
304 304  {{/example}}
191 +{{/expandable}}
305 305  
193 +----
306 306  
307 -== See Also: ==
195 +== Bonus: Boilerplate Example Template ==
308 308  
309 -[[Syntax Help official documentation for a full list of formatting options>>doc:XWiki.XWikiSyntax]]
197 +{{expandable summary="πŸ“‹ Example Macro Template (`/example`)"}}
198 +{{example}}
199 +{{example}}
200 +Your macro goes here.
201 +{{/example}}
202 +{{/example}}
203 +{{/expandable}}
204 +
1747262485678-297.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.AdminAngriff
Size
... ... @@ -1,0 +1,1 @@
1 +1.6 MB
Content