0 Votes

Changes for page Start here if you're new

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

From 13.1 to 14.1 From 35.1 to 36.1

From version

14.1

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

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,278 +1,204 @@
--=   =
++= 📚 Macro Examples & Formatting Guide =
  ----
--==   ==
++== 📖 Table of Contents ==
--== 📖 Table of Contents: ==
--
  {{toc/}}
  ----
--== Getting Started with XWiki ==
++== 🧪 Macro Showcase: Source + Output + Slash Command ==
--This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
++All macros are shown with the WYSIWYG `/command`, an expandable explanation, and an editable source/output block using example
--==   ==
++----
--== 📎 **Attachments and Images** ==
++== Table of Contents Macro (`/toc`) ==
--You can easily upload files and images directly from the WYSIWYG editor:
++{{expandable summary="📘 Table of Contents Macro (`/toc`)"}}
++{{example}}
++{{toc/}}
++{{/example}}
++{{/expandable}}
--**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** ==
++== Gallery Macro (`/gallery`) ==
--The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
++{{expandable summary="🖼️ Gallery Macro (`/gallery`)"}}
++{{example}}
++{{gallery}}
++[[1747262485678-297.png]]
++[[image:photo2.jpg]]
++{{/gallery}}
++{{/example}}
++{{/expandable}}
--* 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)** ==
++== Carousel Macro (`/carousel`) ==
--* **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.
++{{expandable summary="📽️ Carousel Macro (`/carousel`)"}}
++{{example}}
++{{carousel/}}
++{{/example}}
++{{/expandable}}
  ----
--== 🔍 **Useful Tips & Best Practices** ==
++== Box Macro (`/box`) ==
--* **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.
++{{expandable summary="📦 Box Macro (`/box`)"}}
++{{example}}
++{{box cssClass="highlight"}}
++Insert your highlighted content here.
++{{/box}}
++{{/example}}
++{{/expandable}}
  ----
--= ⚡**Guests can contribute** =
++== Info and Warning Boxes (`/info`, `/warning`) ==
--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.
++{{expandable summary="⚠️ Info and Warning Macros (`/info`, `/warning`)"}}
++{{example}}
++{{info}}This is an info box.{{/info}}
--== **Content Guidelines** ==
++{{warning}}This is a warning box.{{/warning}}
++{{/example}}
++{{/expandable}}
--* 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** ==
++== Footnotes (`/footnote`, `/put footnotes`) ==
--* 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.
++{{expandable summary="🧾 Footnote + PutFootnotes (`/footnote`, `/put footnotes`)"}}
++{{example}}
++This is a footnoted statement{{footnote}}https://www.example.com{{/footnote}}.
++{{putFootnotes/}}
++{{/example}}
++{{/expandable}}
++----
--== **XWiki Editing Modes** ==
++== Expandable Macro (`/expandable`) ==
--XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:
++{{expandable summary="🧩 Expandable Macro (`/expandable`)"}}
++{{example}}
++{{expandable summary="Click to expand"}}
++This content is hidden until clicked.
++{{/expandable}}
++{{/example}}
++{{/expandable}}
--* **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** ==
++== Embed Macro (`/embed content`) ==
--To ensure content is both engaging and accessible, utilize the following formatting techniques:
++{{expandable summary="🌐 Embed Macro (YouTube etc.) (`/embed content`)"}}
++{{example}}
++{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
++{{/example}}
++{{/expandable}}
--* **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}}
++== Code Macro (`/code`) ==
--
--=== **Text Formatting** ===
--
--
--
--*
--** (((
--=== **Bold**: Surround text with double asterisks. ===
--)))
--
--{{code}}
--**bold text**
++{{expandable summary="💻 Code Block Macro (`/code`)"}}
++{{example}}
++{{code language="python"}}
++def hello_world():
++    print("Hello, world!")
  {{/code}}
++{{/example}}
++{{/expandable}}
++----
--*
--** (((
--=== **Italics**: Use double underscores. ===
--)))
++== Image Insert (`[[image:...]]`) ==
--{{code}}
--__italic text__
--{{/code}}
++{{expandable summary="🖼️ Image Macro (`[[image:filename.jpg]]`)"}}
++{{example}}
++[[image:1747262485678-297.png]]
++{{/example}}
++{{/expandable}}
++----
--*
--** (((
--=== **Underline**: Enclose text with double tildes. ===
--)))
++== Audio Embed (HTML tag or `/embed JWPlayer`) ==
--{{code}}
--~~underlined text~~
--{{/code}}
++{{expandable summary="🔊 Audio Embed (`<audio>` tag or `/embed JWPlayer`)"}}
++{{example}}
++{{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}}
++----
--*
--** (((
--=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
--)))
++== Video Embed Macro (`/video`) ==
--{{code}}
--* Item 1
--* Item 2
--{{/code}}
++{{expandable summary="🎬 Video Macro (`/video`)"}}
++{{example}}
++{{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
++{{/example}}
++{{/expandable}}
++----
--*
--** (((
--=== **Ordered List**: Start lines with a number followed by a period. ===
--)))
++== Full Example: Expandable Study Summary (`/expandable`) ==
--{{code}}
--1. First item
--2. Second item
--{{/code}}
++{{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="📊 Key Statistics"}}
++- IQ heritability rises to **0.80** by adulthood
++- Shared environment drops to **0.10**
++{{/expandable}}
--== **Links** ==
++{{expandable summary="🔬 Findings"}}
++- Genetic influence strengthens over time
++- Monozygotic twins’ IQ similarity increases with age
++{{/expandable}}
++{{expandable summary="📝 Critique & Observations"}}
++- Strength: Large dataset, longitudinal
++- Limitation: Mostly Western countries
++{{/expandable}}
++{{expandable summary="📌 Relevance"}}
++- Strong support for genetic IQ theories
++- Diminishing environmental influence
++{{/expandable}}
--==== **Internal Link**: Use square brackets with the page name. ====
++{{expandable summary="📄 Download"}}
++[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
++{{/expandable}}
--{{code}}
--[[PageName]]
--{{/code}}
++{{/expandable}}
++{{/example}}
++{{/expandable}}
++----
++== Bonus: Boilerplate Example Template ==
--==== **External Link**: Provide the URL directly. ====
++{{expandable summary="📋 Example Macro Template (`/example`)"}}
++{{example}}
++{{example}}
++Your macro goes here.
++{{/example}}
++{{/example}}
++{{/expandable}}
--{{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:
--
--**Box Macro**: Encapsulates content within a styled box, useful for highlighting information.
--
--{{code}}
--{{box}}
--Your content here.
--{{/box}}
--{{/code}}
--
--
--=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
--
--{{code}}
--{{info}}
--This is an informational note.
--{{/info}}
--{{/code}}
--
--
--=== **Warning Macro**: Highlights warnings or important notices. ===
--
--{{code}}
--{{warning}}
--Caution: Proceed with care.
--{{/warning}}
--{{/code}}
--
--
--=== **Code Macro**: Renders code snippets with syntax highlighting. ===
--
--{{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}}
--
--
--=== **Include Macro**: Embeds content from another page. ===
--
--{{code}}
--{{include reference="PageName"/}}
--{{/code}}
--
--
--=== **Display Macro**: Displays the content of another document or an object property. ===
--
--{{code}}
--{{display reference="PageName"/}}
--{{/code}}
--
--
--=== **Velocity Macro**: Executes Velocity scripts for dynamic content generation. ===
--
--{{code}}
--{{velocity}}
--#set($greeting = "Hello, $user.name!")
--$greeting
--{{/velocity}}
--{{/code}}
--
--== See Also: ==
--
--[[Syntax Help official documentation for a full list of formatting options>>doc:XWiki.XWikiSyntax]]

1747262485678-297.png

Author

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

Size

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

Content