0 Votes

Changes for page Start here if you're new

Last modified by Ryan C on 2025/05/14 17:18

From version 34.1
edited by Ryan C
on 2025/05/14 16:06
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,124 +1,32 @@
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 -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**:
13 +All macros are shown with the WYSIWYG `/command`, an expandable explanation, and an editable source/output block using example
16 16  
17 -
18 -
19 -== πŸ” **Useful Tips & Best Practices** ==
20 -
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.
25 -
26 26  ----
27 27  
28 -= ⚑**Guests can contribute** =
17 +== Table of Contents Macro (`/toc`) ==
29 29  
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.
19 +{{expandable summary="πŸ“˜ Table of Contents Macro (`/toc`)"}}
20 +{{example}}
21 +{{toc/}}
22 +{{/example}}
23 +{{/expandable}}
33 33  
34 -== **Content Guidelines** ==
35 -
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.
38 -
39 -== **Directories and Page URLs** ==
40 -
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.
42 -
43 -
44 -
45 -== **XWiki Editing Modes** ==
46 -
47 -XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:ξˆ†
48 -
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.ξˆ†
51 -
52 -== **Essential Formatting Options** ==
53 -
54 -To ensure content is both engaging and accessible, utilize the following formatting techniques:ξˆ†
55 -
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.ξˆ†
57 -
58 -{{code}}
59 - + Heading Level 1
60 - ++ Heading Level 2
61 - +++ Heading Level 3
62 -{{/code}}
63 -
64 -
65 -== **Links** ==
66 -
67 -
68 -
69 -==== **Internal Link**: Use square brackets with the page name. ====
70 -
71 -{{code}}
72 -[[PageName]]
73 -{{/code}}
74 -
75 -
76 -
77 -==== **External Link**: Provide the URL directly. ====
78 -
79 -{{code}}
80 -[https://www.example.com]
81 -{{/code}}
82 -
83 -(((
84 -=== ===
85 -)))
86 -
87 -
88 -== ==
89 -
90 -== ⚑ **Using the / Macro Shortcut** ==
91 -
92 -The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
93 -
94 -* Simply type / and start typing the macro name or feature you want to add.
95 -* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
96 -* Example macros include:
97 -** /toc – Table of Contents
98 -** /box – Insert Box Macro
99 -** /gallery – Image Gallery
100 -** /footnote – Add footnotes to your text
101 -** /code – Code blocks for programming snippets
102 -
103 -This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax
104 -
105 105  ----
106 106  
107 -## πŸ§ͺ 1. **Macro Showcase: Source-to-Output Toggle**##
27 +== Gallery Macro (`/gallery`) ==
108 108  
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
110 -
111 -
112 -=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
113 -
114 -
115 -{{code}}
116 -{{toc/}}
117 -{{/code}}
118 -
119 -
120 -== **Gallery Macro** `/gallery` ==
121 -
29 +{{expandable summary="πŸ–ΌοΈ Gallery Macro (`/gallery`)"}}
122 122  {{example}}
123 123  {{gallery}}
124 124  [[1747262485678-297.png]]
... ... @@ -125,221 +125,172 @@
125 125  [[image:photo2.jpg]]
126 126  {{/gallery}}
127 127  {{/example}}
36 +{{/expandable}}
128 128  
38 +----
129 129  
130 -== **Alternatively** `/carousel` ==
40 +== Carousel Macro (`/carousel`) ==
131 131  
42 +{{expandable summary="πŸ“½οΈ Carousel Macro (`/carousel`)"}}
132 132  {{example}}
133 133  {{carousel/}}
134 -
135 -
136 136  {{/example}}
46 +{{/expandable}}
137 137  
138 -== **Boilerplate Box** ==
48 +----
139 139  
50 +== Box Macro (`/box`) ==
51 +
52 +{{expandable summary="πŸ“¦ Box Macro (`/box`)"}}
140 140  {{example}}
141 141  {{box cssClass="highlight"}}
142 142  Insert your highlighted content here.
143 143  {{/box}}
144 144  {{/example}}
58 +{{/expandable}}
145 145  
146 -== ==
60 +----
147 147  
148 -== **Info vs Warning **`/info box` ==
62 +== Info and Warning Boxes (`/info`, `/warning`) ==
149 149  
64 +{{expandable summary="⚠️ Info and Warning Macros (`/info`, `/warning`)"}}
150 150  {{example}}
151 -{{info}}
152 -This is an info box.
153 -{{/info}}
66 +{{info}}This is an info box.{{/info}}
154 154  
155 -{{warning}}
156 -This is a warning box.
157 -{{/warning}}
68 +{{warning}}This is a warning box.{{/warning}}
158 158  {{/example}}
70 +{{/expandable}}
159 159  
160 -== **Footnote Demo** `/footnote and /put footnotes` put the put footnotes macro at the bottom where you want the references ==
72 +----
161 161  
74 +== Footnotes (`/footnote`, `/put footnotes`) ==
75 +
76 +{{expandable summary="🧾 Footnote + PutFootnotes (`/footnote`, `/put footnotes`)"}}
162 162  {{example}}
163 -footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}}
78 +This is a footnoted statement{{footnote}}https://www.example.com{{/footnote}}.
164 164  
165 165  {{putFootnotes/}}
166 166  {{/example}}
82 +{{/expandable}}
167 167  
84 +----
168 168  
169 -== ==
86 +== Expandable Macro (`/expandable`) ==
170 170  
171 -== **Expandable Summary** `/expandable`  VERY USEFUL MACRO ==
172 -
88 +{{expandable summary="🧩 Expandable Macro (`/expandable`)"}}
173 173  {{example}}
174 -{{expandable summary="🧠 Study Summary"}}
175 -Key findings go here.
90 +{{expandable summary="Click to expand"}}
91 +This content is hidden until clicked.
176 176  {{/expandable}}
177 177  {{/example}}
94 +{{/expandable}}
178 178  
179 -== ==
96 +----
180 180  
181 -== πŸ“Ž **Attachments and Images** ==
98 +== Embed Macro (`/embed content`) ==
182 182  
183 -You can easily upload files and images directly from the WYSIWYG editor:
100 +{{expandable summary="🌐 Embed Macro (YouTube etc.) (`/embed content`)"}}
101 +{{example}}
102 +{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
103 +{{/example}}
104 +{{/expandable}}
184 184  
185 -**Uploading Attachments:**
106 +----
186 186  
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.
108 +== Code Macro (`/code`) ==
191 191  
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` ==
193 -
110 +{{expandable summary="πŸ’» Code Block Macro (`/code`)"}}
194 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}}
112 +{{code language="python"}}
113 +def hello_world():
114 + print("Hello, world!")
115 +{{/code}}
201 201  {{/example}}
117 +{{/expandable}}
202 202  
203 -This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
119 +----
204 204  
205 -=== **Inserting Images with Enlargable Thumbnails** ===
121 +== Image Insert (`[[image:...]]`) ==
206 206  
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.
210 -
211 -[[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]]
212 -
213 -
214 -
215 -
216 -=== **Alternatively: `~[~[image~:image.png]]`** ===
217 -
123 +{{expandable summary="πŸ–ΌοΈ Image Macro (`[[image:filename.jpg]]`)"}}
218 218  {{example}}
219 219  [[image:1747262485678-297.png]]
220 220  {{/example}}
127 +{{/expandable}}
221 221  
222 -
223 -
224 -== ==
225 -
226 226  ----
227 227  
228 -== **Utilizing XWiki Macros** ==
131 +== Audio Embed (HTML tag or `/embed JWPlayer`) ==
229 229  
230 -Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:ξˆ†
231 -
232 -== Embed Macro ==
233 -
234 -The Embed macro shows external content like YouTube videos.
235 -
133 +{{expandable summary="πŸ”Š Audio Embed (`<audio>` tag or `/embed JWPlayer`)"}}
236 236  {{example}}
237 -{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
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}}
238 238  {{/example}}
142 +{{/expandable}}
239 239  
144 +----
240 240  
241 -=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
146 +== Video Embed Macro (`/video`) ==
242 242  
243 -{{code}}
244 -{{info}}
245 -This is an informational note.
246 -{{/info}}
247 -{{/code}}
248 -
249 -
250 -== **Code Macro**: Renders code snippets with syntax highlighting. ==
251 -
252 -{{code}}
253 -{{code language="python"}}
254 -def hello_world():
255 - print("Hello, world!")
256 -{{/code}}
257 -{{/code}}
258 -
259 -
260 -== **Video Macro**: `/video` The Video macro embeds videos. ==
261 -
148 +{{expandable summary="🎬 Video Macro (`/video`)"}}
262 262  {{example}}
263 263  {{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
264 264  {{/example}}
152 +{{/expandable}}
265 265  
154 +----
266 266  
267 -== Example Macro ==
156 +== Full Example: Expandable Study Summary (`/expandable`) ==
268 268  
269 -The example macro displays the output of a macro or script or anything that you like
270 -
271 -== Expandable Macro ==
272 -
273 -The following example demonstrates how to present complex information cleanly using `
274 -
158 +{{expandable summary="πŸ“š Full Use Case – Study Summary Macro (`/expandable`)"}}
275 275  {{example}}
276 -{{expandable summary="Study: The Wilson Effect: The Increase in Heritability of IQ With Age"}}
277 -**Source:** *Twin Research and Human Genetics (Cambridge University Press)*
278 -**Date of Publication:** *2013*
279 -**Author(s):** *Thomas J. Bouchard Jr.*
280 -**Title:** *"The Wilson Effect: The Increase in Heritability of IQ With Age"*
281 -**DOI:** [10.1017/thg.2013.54](https://doi.org/10.1017/thg.2013.54)
282 -**Subject Matter:** *Intelligence, Heritability, Developmental Psychology*
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)
283 283  
284 284  {{expandable summary="πŸ“Š Key Statistics"}}
285 -1. **General Observations:**
286 - - The study documents how the **heritability of IQ increases with age**, reaching an asymptote at **0.80 by adulthood**.
287 - - Analysis is based on **longitudinal twin and adoption studies**.
288 -
289 -2. **Subgroup Analysis:**
290 - - Shared environmental influence on IQ **declines with age**, reaching **0.10 in adulthood**.
291 - - Monozygotic twins show **increasing genetic similarity in IQ over time**, while dizygotic twins become **less concordant**.
292 -
293 -3. **Other Significant Data Points:**
294 - - Data from the **Louisville Longitudinal Twin Study and cross-national twin samples** support findings.
295 - - IQ stability over time is **influenced more by genetics than by shared environmental factors**.
166 +- IQ heritability rises to **0.80** by adulthood
167 +- Shared environment drops to **0.10**
296 296  {{/expandable}}
297 297  
298 298  {{expandable summary="πŸ”¬ Findings"}}
299 -1. **Primary Observations:**
300 - - Intelligence heritability **strengthens throughout development**, contrary to early environmental models.
301 - - Shared environmental effects **decrease by late adolescence**, emphasizing **genetic influence in adulthood**.
302 -
303 -2. **Subgroup Trends:**
304 - - Studies from **Scotland, Netherlands, and the US** show **consistent patterns of increasing heritability with age**.
305 - - Findings hold across **varied socio-economic and educational backgrounds**.
306 -
307 -3. **Specific Case Analysis:**
308 - - Longitudinal adoption studies show **declining impact of adoptive parental influence on IQ** as children age.
309 - - Cross-sectional twin data confirm **higher IQ correlations for monozygotic twins in adulthood**.
171 +- Genetic influence strengthens over time
172 +- Monozygotic twins’ IQ similarity increases with age
310 310  {{/expandable}}
311 311  
312 312  {{expandable summary="πŸ“ Critique & Observations"}}
313 -1. **Strengths of the Study:**
314 - - **Robust dataset covering multiple twin and adoption studies over decades**.
315 - - **Clear, replicable trend** demonstrating the increasing role of genetics in intelligence.
316 -
317 -2. **Limitations of the Study:**
318 - - Findings apply primarily to **Western industrialized nations**, limiting generalizability.
319 - - **Lack of neurobiological mechanisms** explaining how genes express their influence over time.
320 -
321 -3. **Suggestions for Improvement:**
322 - - Future research should investigate **gene-environment interactions in cognitive aging**.
323 - - Examine **heritability trends in non-Western populations** to determine cross-cultural consistency.
176 +- Strength: Large dataset, longitudinal
177 +- Limitation: Mostly Western countries
324 324  {{/expandable}}
325 325  
326 -{{expandable summary="πŸ“Œ Relevance to Subproject"}}
327 -- Provides **strong evidence for the genetic basis of intelligence**.
328 -- Highlights the **diminishing role of shared environment in cognitive development**.
329 -- Supports research on **cognitive aging and heritability across the lifespan**.
180 +{{expandable summary="πŸ“Œ Relevance"}}
181 +- Strong support for genetic IQ theories
182 +- Diminishing environmental influence
330 330  {{/expandable}}
331 331  
332 -{{expandable summary="πŸ” Suggestions for Further Exploration"}}
333 -1. Investigate **neurogenetic pathways underlying IQ development**.
334 -2. Examine **how education and socioeconomic factors interact with genetic IQ influences**.
335 -3. Study **heritability trends in aging populations and cognitive decline**.
185 +{{expandable summary="πŸ“„ Download"}}
186 +[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
336 336  {{/expandable}}
337 337  
338 -{{expandable summary="πŸ“„ Download Full Study"}}
339 -[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
340 340  {{/expandable}}
341 -{{/expandable}}
342 342  {{/example}}
191 +{{/expandable}}
343 343  
193 +----
344 344  
345 -
195 +== Bonus: Boilerplate Example Template ==
196 +
197 +{{expandable summary="πŸ“‹ Example Macro Template (`/example`)"}}
198 +{{example}}
199 +{{example}}
200 +Your macro goes here.
201 +{{/example}}
202 +{{/example}}
203 +{{/expandable}}
204 +