0 Votes

Changes for page Start here if you're new

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

From 21.1 to 22.1 From 35.1 to 36.1

From version

22.1

edited by Ryan C
on 2025/05/14 13:41

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

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 1 added, 0 removed)
- 1747262485678-297.png

Details

Page properties

Content

@@ -1,502 +1,204 @@
--=   =
++= 📚 Macro Examples & Formatting Guide =
  ----
--==   ==
++== 📖 Table of Contents ==
--== 📖 Table of Contents: ==
--
  {{toc/}}
  ----
--== Getting Started with XWiki ==
++== 🧪 Macro Showcase: Source + Output + Slash Command ==
--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**:
++All macros are shown with the WYSIWYG `/command`, an expandable explanation, and an editable source/output block using example
-----
++----
--## 🧪 1. **Macro Showcase: Source-to-Output Toggle**
++== Table of Contents Macro (`/toc`) ==
--Show how a macro works without cluttering the page with raw syntax.
++{{expandable summary="📘 Table of Contents Macro (`/toc`)"}}
++{{example}}
++{{toc/}}
++{{/example}}
++{{/expandable}}
--```xwiki
--== Gallery Macro ==
++----
++
++== Gallery Macro (`/gallery`) ==
++
++{{expandable summary="🖼️ Gallery Macro (`/gallery`)"}}
  {{example}}
  {{gallery}}
--[[image:photo1.jpg]]
++[[1747262485678-297.png]]
  [[image:photo2.jpg]]
  {{/gallery}}
  {{/example}}
--```
++{{/expandable}}
--**Why it's good:** New users see both source and result without confusion.
++----
-----
++== Carousel Macro (`/carousel`) ==
--## 📝 2. **Editable Template Snippets**
++{{expandable summary="📽️ Carousel Macro (`/carousel`)"}}
++{{example}}
++{{carousel/}}
++{{/example}}
++{{/expandable}}
--Use `{{example}}` to store reusable content that users can copy, paste, and modify.
++----
--```xwiki
--== Boilerplate Box ==
++== Box Macro (`/box`) ==
++
++{{expandable summary="📦 Box Macro (`/box`)"}}
  {{example}}
  {{box cssClass="highlight"}}
  Insert your highlighted content here.
  {{/box}}
  {{/example}}
--```
++{{/expandable}}
-----
++----
--## 🎓 3. **Educational Tutorials (e.g., Velocity or Groovy)**
++== Info and Warning Boxes (`/info`, `/warning`) ==
--Teach scripting with real, live code examples.
--
--```xwiki
--== Velocity Greeting ==
++{{expandable summary="⚠️ Info and Warning Macros (`/info`, `/warning`)"}}
  {{example}}
--{{velocity}}
--#set($name = "Visitor")
--Hello, $name!
--{{/velocity}}
--{{/example}}
--```
--
-----
--
--## 🎯 4. **Comparing Macro Parameters**
--
--Demonstrate how different macro parameters change output—side-by-side.
--
--```xwiki
--== Info vs Warning ==
--{{example}}
  {{info}}This is an info box.{{/info}}
  {{warning}}This is a warning box.{{/warning}}
  {{/example}}
--```
++{{/expandable}}
-----
++----
--## 🧩 5. **Interactive Data Blocks (TOC, Footnotes, etc.)**
++== Footnotes (`/footnote`, `/put footnotes`) ==
--Visually show what happens when you use certain macros together.
--
--```xwiki
--== Footnote Demo ==
++{{expandable summary="🧾 Footnote + PutFootnotes (`/footnote`, `/put footnotes`)"}}
  {{example}}
--This claim needs a source{{footnote}}Here it is.{{/footnote}}.
++This is a footnoted statement{{footnote}}https://www.example.com{{/footnote}}.
++
  {{putFootnotes/}}
  {{/example}}
--```
++{{/expandable}}
-----
++----
--## 🧪 6. **Live Scripting Playgrounds**
++== Expandable Macro (`/expandable`) ==
--Embed small self-contained scripting playgrounds where users can view or modify dynamic output.
--
--```xwiki
--== Groovy Lookup ==
++{{expandable summary="🧩 Expandable Macro (`/expandable`)"}}
  {{example}}
--{{groovy}}
--def now = new Date()
--println("Current time: " + now)
--{{/groovy}}
++{{expandable summary="Click to expand"}}
++This content is hidden until clicked.
++{{/expandable}}
  {{/example}}
--```
++{{/expandable}}
-----
++----
--## 📦 7. **Component/API Call Demos**
++== Embed Macro (`/embed content`) ==
--Useful for devs exploring the API.
--
--```xwiki
--== Access Current User ==
++{{expandable summary="🌐 Embed Macro (YouTube etc.) (`/embed content`)"}}
  {{example}}
--{{velocity}}
--Current user: **$xcontext.user**
--{{/velocity}}
++{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
  {{/example}}
--```
--
-----
--
--## 📘 8. **Expandable Wiki Templates with Output**
--
--Pair `{{example}}` with `{{expandable}}` for full disclosure without visual clutter.
--
--```xwiki
--== Expandable Summary ==
--{{example}}
--{{expandable summary="🧠 Study Summary"}}
--Key findings go here.
  {{/expandable}}
--{{/example}}
--```
-----
++----
--## 🔧 9. **Syntax Training: Bad vs Good**
++== Code Macro (`/code`) ==
--Side-by-side "Do this, not that" with toggles.
--
--```xwiki
--== List Formatting ==
++{{expandable summary="💻 Code Block Macro (`/code`)"}}
  {{example}}
--*Bad formatting*
--* use - inconsistently
--** Good formatting:
--  * Consistent bullet style
--  * Indented items properly
--{{/example}}
--```
--
-----
--
--## 💡 Bonus Tip: Combine `{{example}}` + `{{code}}` for Highlighted Snippets
--
--```xwiki
--== Python Code ==
--{{example}}
  {{code language="python"}}
--def greet():
--    print("Hello World")
++def hello_world():
++    print("Hello, world!")
  {{/code}}
  {{/example}}
--```
++{{/expandable}}
-----
--
--Want me to generate a panel with these uses or make a macro gallery page pre-filled with them?
--
--
--This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
--
--==   ==
--
--== 📎 **Attachments and Images** ==
--
--You can easily upload files and images directly from the WYSIWYG editor:
--
--**Uploading Attachments:**
--
--* Click **Edit** to enter the WYSIWYG editor.
--* Click on the **Attachment** icon (📎 paperclip icon).
--* Drag-and-drop or select your file to upload it instantly.
--* Uploaded files will automatically be listed as attachments at the bottom of your page.
--
--=== **Inserting Images with Enlargable Thumbnails** ===
--
--1. In the editor, click the **"Insert Image"** icon from the toolbar.
--1. Upload or select the image.
--1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
--
  ----
--== ⚡ **Using the / Macro Shortcut** ==
++== Image Insert (`[[image:...]]`) ==
--The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
--
--* Simply type / and start typing the macro name or feature you want to add.
--* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
--* Example macros include:
--** /toc – Table of Contents
--** /box – Insert Box Macro
--** /gallery – Image Gallery
--** /footnote – Add footnotes to your text
--** /code – Code blocks for programming snippets
--
--This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax.
--
------
--
--== ✏️** Basic Formatting and Links (Quick Guide)** ==
--
--* **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
--* **Italic text**: Select text, click "Italic" in the toolbar or use Ctrl+I.
--* **Creating Links**:
--** Highlight text and click **"Link"** or use shortcut Ctrl+K.
--** Paste or select the page URL to link internally.
--
------
--
--== 🔍 **Useful Tips & Best Practices** ==
--
--* **Save drafts frequently:** Press Ctrl+S regularly.
--* **Macros** greatly simplify content formatting—use / often.
--* **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them.
--* **Use minimal formatting** to ensure readability.
--
------
--
--= ⚡**Guests can contribute** =
--
--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.
--1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
--1. Leave comments, give suggestions, request features.
--
--== **Content Guidelines** ==
--
--* 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.
--* 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.
--
--== **Directories and Page URLs** ==
--
--* 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.
--
--
--
--== **XWiki Editing Modes** ==
--
--XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:
--
--* **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
--* **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.
--* **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.
--
--== **Essential Formatting Options** ==
--
--To ensure content is both engaging and accessible, utilize the following formatting techniques:
--
--* **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.
--
--{{code}}
--  + Heading Level 1
--  ++ Heading Level 2
--  +++ Heading Level 3
--{{/code}}
--
--
--=== **Text Formatting** ===
--
--
--
--*
--** (((
--=== **Bold**: Surround text with double asterisks. ===
--)))
--
--{{code}}
--**bold text**
--{{/code}}
--
--
--*
--** (((
--=== **Italics**: Use double underscores. ===
--)))
--
--{{code}}
--__italic text__
--{{/code}}
--
--
--*
--** (((
--=== **Underline**: Enclose text with double tildes. ===
--)))
--
--{{code}}
--~~underlined text~~
--{{/code}}
--
--
--*
--** (((
--=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
--)))
--
--{{code}}
--* Item 1
--* Item 2
--{{/code}}
--
--
--*
--** (((
--=== **Ordered List**: Start lines with a number followed by a period. ===
--)))
--
--{{code}}
--1. First item
--2. Second item
--{{/code}}
--
--
--== **Links** ==
--
--
--
--==== **Internal Link**: Use square brackets with the page name. ====
--
--{{code}}
--[[PageName]]
--{{/code}}
--
--
--
--==== **External Link**: Provide the URL directly. ====
--
--{{code}}
--[https://www.example.com]
--{{/code}}
--
--(((
--=== **Images** ===
--)))
--
--{{code}}
--  [[image:example.jpg]]
--{{/code}}
--
--
--== **Utilizing XWiki Macros** ==
--
--Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
--
--== Embed Macro ==
--
--The Embed macro shows external content like YouTube videos.
--
++{{expandable summary="🖼️ Image Macro (`[[image:filename.jpg]]`)"}}
  {{example}}
--{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
++[[image:1747262485678-297.png]]
  {{/example}}
++{{/expandable}}
++----
--=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
++== Audio Embed (HTML tag or `/embed JWPlayer`) ==
--{{code}}
--{{info}}
--This is an informational note.
--{{/info}}
--{{/code}}
--
--
--== Footnote Macro ==
--
--The Footnote macro adds footnotes to the page.
--
++{{expandable summary="🔊 Audio Embed (`<audio>` tag or `/embed JWPlayer`)"}}
  {{example}}
--This is a statement{{footnote}}Source: Example Reference{{/footnote}}.
--{{putFootnotes/}}
++{{html}}
++<audio controls>
++  <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
++  Your browser does not support the audio element.
++</audio>
++{{/html}}
  {{/example}}
++{{/expandable}}
++----
--=== **Code Macro**: Renders code snippets with syntax highlighting. ===
++== Video Embed Macro (`/video`) ==
--{{code}}
--{{code language="python"}}
--def hello_world():
--    print("Hello, world!")
--{{/code}}
--{{/code}}
--
--
--=== **Gallery Macro**: Creates an image gallery from attached images. ===
--
--{{code}}
--{{gallery}}
--[[image1.jpg]]
--[[image2.jpg]]
--{{/gallery}}
--{{/code}}
--
--
--=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
--
--{{code}}
--{{toc/}}
--{{/code}}
--
--== Video Macro ==
--
--The Video macro embeds videos.
--
++{{expandable summary="🎬 Video Macro (`/video`)"}}
  {{example}}
  {{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
  {{/example}}
++{{/expandable}}
++----
--== Example Macro ==
++== Full Example: Expandable Study Summary (`/expandable`) ==
--The example macro displays the output of a macro or script or anything that you like
--== Expandable Macro ==
--
--The following example demonstrates how to present complex information cleanly using `
--
++{{expandable summary="📚 Full Use Case – Study Summary Macro (`/expandable`)"}}
  {{example}}
++{{expandable summary="Study: The Wilson Effect"}}
++**Source:** *Twin Research and Human Genetics (2013)*
++**Author:** *Thomas J. Bouchard Jr.*
++**DOI:** [10.1017/thg.2013.54](https://doi.org/10.1017/thg.2013.54)
--{{expandable summary="Study: The Wilson Effect: The Increase in Heritability of IQ With Age"}}
--**Source:** *Twin Research and Human Genetics (Cambridge University Press)*
--**Date of Publication:** *2013*
--**Author(s):** *Thomas J. Bouchard Jr.*
--**Title:** *"The Wilson Effect: The Increase in Heritability of IQ With Age"*
--**DOI:** [10.1017/thg.2013.54](https://doi.org/10.1017/thg.2013.54)
--**Subject Matter:** *Intelligence, Heritability, Developmental Psychology*
--
  {{expandable summary="📊 Key Statistics"}}
--1. **General Observations:**
--   - The study documents how the **heritability of IQ increases with age**, reaching an asymptote at **0.80 by adulthood**.
--   - Analysis is based on **longitudinal twin and adoption studies**.
--
--2. **Subgroup Analysis:**
--   - Shared environmental influence on IQ **declines with age**, reaching **0.10 in adulthood**.
--   - Monozygotic twins show **increasing genetic similarity in IQ over time**, while dizygotic twins become **less concordant**.
--
--3. **Other Significant Data Points:**
--   - Data from the **Louisville Longitudinal Twin Study and cross-national twin samples** support findings.
--   - IQ stability over time is **influenced more by genetics than by shared environmental factors**.
++- IQ heritability rises to **0.80** by adulthood
++- Shared environment drops to **0.10**
  {{/expandable}}
  {{expandable summary="🔬 Findings"}}
--1. **Primary Observations:**
--   - Intelligence heritability **strengthens throughout development**, contrary to early environmental models.
--   - Shared environmental effects **decrease by late adolescence**, emphasizing **genetic influence in adulthood**.
--
--2. **Subgroup Trends:**
--   - Studies from **Scotland, Netherlands, and the US** show **consistent patterns of increasing heritability with age**.
--   - Findings hold across **varied socio-economic and educational backgrounds**.
--
--3. **Specific Case Analysis:**
--   - Longitudinal adoption studies show **declining impact of adoptive parental influence on IQ** as children age.
--   - Cross-sectional twin data confirm **higher IQ correlations for monozygotic twins in adulthood**.
++- Genetic influence strengthens over time
++- Monozygotic twins’ IQ similarity increases with age
  {{/expandable}}
  {{expandable summary="📝 Critique & Observations"}}
--1. **Strengths of the Study:**
--   - **Robust dataset covering multiple twin and adoption studies over decades**.
--   - **Clear, replicable trend** demonstrating the increasing role of genetics in intelligence.
--
--2. **Limitations of the Study:**
--   - Findings apply primarily to **Western industrialized nations**, limiting generalizability.
--   - **Lack of neurobiological mechanisms** explaining how genes express their influence over time.
--
--3. **Suggestions for Improvement:**
--   - Future research should investigate **gene-environment interactions in cognitive aging**.
--   - Examine **heritability trends in non-Western populations** to determine cross-cultural consistency.
++- Strength: Large dataset, longitudinal
++- Limitation: Mostly Western countries
  {{/expandable}}
--{{expandable summary="📌 Relevance to Subproject"}}
--- Provides **strong evidence for the genetic basis of intelligence**.
--- Highlights the **diminishing role of shared environment in cognitive development**.
--- Supports research on **cognitive aging and heritability across the lifespan**.
++{{expandable summary="📌 Relevance"}}
++- Strong support for genetic IQ theories
++- Diminishing environmental influence
  {{/expandable}}
--{{expandable summary="🔍 Suggestions for Further Exploration"}}
--1. Investigate **neurogenetic pathways underlying IQ development**.
--2. Examine **how education and socioeconomic factors interact with genetic IQ influences**.
--3. Study **heritability trends in aging populations and cognitive decline**.
++{{expandable summary="📄 Download"}}
++[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
  {{/expandable}}
--{{expandable summary="📄 Download Full Study"}}
--[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
  {{/expandable}}
--{{/expandable}}
  {{/example}}
++{{/expandable}}
++----
++== Bonus: Boilerplate Example Template ==
++{{expandable summary="📋 Example Macro Template (`/example`)"}}
++{{example}}
++{{example}}
++Your macro goes here.
++{{/example}}
++{{/example}}
++{{/expandable}}
++

1747262485678-297.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.AdminAngriff

Size

...	...	@@ -1,0 +1,1 @@
	1	+1.6 MB

Content