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 33.1 to 34.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

33.1

edited by Ryan C
on 2025/05/14 15:59

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

@@ -12,49 +12,60 @@
  == Getting Started with XWiki ==
--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**:
++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**:
-----
--## 🧪 1. **Macro Showcase: Source-to-Output Toggle**
--Show how a macro works without cluttering the page with raw syntax.
++== ⚡ **Using the / Macro Shortcut** ==
--```xwiki
--== Gallery Macro ==
++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
++
++----
++
++## 🧪 1. **Macro Showcase: Source-to-Output Toggle**##
++
++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
++
++
++== Gallery Macro `/gallery` ==
++
  {{example}}
  {{gallery}}
--[[image:photo1.jpg]]
++[[1747262485678-297.png]]
  [[image:photo2.jpg]]
  {{/gallery}}
  {{/example}}
--```
--**Why it's good:** New users see both source and result without confusion.
-----
++== Alternatively `/carousel` ==
--## 📝 2. **Editable Template Snippets**
++{{example}}
++{{carousel/}}
--Use `{{example}}` to store reusable content that users can copy, paste, and modify.
++
++{{/example}}
--```xwiki
  == Boilerplate Box ==
++
  {{example}}
  {{box cssClass="highlight"}}
  Insert your highlighted content here.
  {{/box}}
  {{/example}}
--```
-----
--
--## 🎓 3. **Educational Tutorials (e.g., Velocity or Groovy)**
--
--Teach scripting with real, live code examples.
--
--```xwiki
  == Velocity Greeting ==
++
  {{example}}
  {{velocity}}
  #set($name = "Visitor")
@@ -61,45 +61,31 @@
  Hello, $name!
  {{/velocity}}
  {{/example}}
--```
-----
--## 🎯 4. **Comparing Macro Parameters**
++== Info vs Warning `/info box` ==
--Demonstrate how different macro parameters change output—side-by-side.
--
--```xwiki
--== Info vs Warning ==
  {{example}}
--{{info}}This is an info box.{{/info}}
++{{info}}
++This is an info box.
++{{/info}}
--{{warning}}This is a warning box.{{/warning}}
++{{warning}}
++This is a warning box.
++{{/warning}}
  {{/example}}
--```
-----
++== Footnote Demo `/footnote and /put footnotes` put the put footnotes macro at the bottom where you want the references ==
--## 🧩 5. **Interactive Data Blocks (TOC, Footnotes, etc.)**
--
--Visually show what happens when you use certain macros together.
--
--```xwiki
--== Footnote Demo ==
  {{example}}
--This claim needs a source{{footnote}}Here it is.{{/footnote}}.
++footnote{{footnote}} https://www.thewhitearchive.org/bin/view/Guides%20and%20Help/Start%20here%20if%20you're%20new/#edit{{/footnote}}
++
  {{putFootnotes/}}
  {{/example}}
--```
-----
--## 🧪 6. **Live Scripting Playgrounds**
--
--Embed small self-contained scripting playgrounds where users can view or modify dynamic output.
--
--```xwiki
  == Groovy Lookup ==
++
  {{example}}
  {{groovy}}
  def now = new Date()
@@ -106,61 +106,29 @@
  println("Current time: " + now)
  {{/groovy}}
  {{/example}}
--```
-----
--## 📦 7. **Component/API Call Demos**
++== Expandable Summary `/expandable`  VERY USEFUL MACRO ==
--Useful for devs exploring the API.
--
--```xwiki
--== Access Current User ==
  {{example}}
--{{velocity}}
--Current user: **$xcontext.user**
--{{/velocity}}
--{{/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**
--
--Side-by-side "Do this, not that" with toggles.
--
--```xwiki
  == List Formatting ==
++
  {{example}}
  *Bad formatting*
++
  * use - inconsistently
  ** Good formatting:
--  * Consistent bullet style
--  * Indented items properly
++* Consistent bullet style
++* Indented items properly
  {{/example}}
--```
-----
--
--## 💡 Bonus Tip: Combine `{{example}}` + `{{code}}` for Highlighted Snippets
--
--```xwiki
  == Python Code ==
++
  {{example}}
  {{code language="python"}}
  def greet():
@@ -167,17 +167,10 @@
      print("Hello World")
  {{/code}}
  {{/example}}
--```
-----
++==  ==
--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:
@@ -189,6 +189,19 @@
  * 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.
++== 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` ==
++
++{{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}}
++
++This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
++
  === **Inserting Images with Enlargable Thumbnails** ===
 . In the editor, click the **"Insert Image"** icon from the toolbar.
@@ -195,25 +195,27 @@
 . Upload or select the image.
 . Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
------
++[[image:1747262485678-297.png||data-xwiki-image-style="thumbnail-clickable" width="200"]]
--== ⚡ **Using the / Macro Shortcut** ==
--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.
++=== **You can also use this format to insert images** ===
------
++{{example}}
++[[image:1747262485678-297.png]]
++{{/example}}
++
++
++
++{{code}}
++  [[image:example.jpg]]
++{{/code}}
++
++
++
++
  == ✏️** Basic Formatting and Links (Quick Guide)** ==
  * **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
@@ -256,7 +256,6 @@
  * **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** ==
@@ -271,62 +271,6 @@
  {{/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** ==
@@ -346,14 +346,9 @@
  {{/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:
@@ -424,12 +424,12 @@
  == Example Macro ==
  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 `
  {{example}}
--
  {{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*
@@ -499,4 +499,4 @@
  {{/example}}
--
++

1747262485678-297.png

Author

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

Size

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

Content

Changes for page Start here if you're new

Summary

Details

Quick Links

Categories