0 Votes

Changes for page Start here if you're new

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

From version 36.1
edited by Ryan C
on 2025/05/14 16:36
Change comment: There is no comment for this version
To version 6.1
edited by Ryan C
on 2025/03/16 01:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,52 +1,112 @@
1 += =
1 1  
2 2  ----
3 3  
4 -== πŸ“– Table of Contents ==
5 +== Getting Started with XWiki ==
5 5  
6 -{{toc/}}
7 +This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
7 7  
9 +== πŸ“– Table of Contents: ==
10 +
11 +* [[Editing with the WYSIWYG Editor>>https://chatgpt.com/c/67d66d62-3244-800a-8974-570f38118948#editing-pages]]
12 +* [[Inserting Attachments and Images>>https://chatgpt.com/c/67d66d62-3244-800a-8974-570f38118948#attachments]]
13 +* [[Using the / Macro Shortcut>>https://chatgpt.com/c/67d66d62-3244-800a-8974-570f38118948#macros]]
14 +* [[Basic Formatting and Links>>https://chatgpt.com/c/67d66d62-3244-800a-8974-570f38118948#formatting]]
15 +* [[Useful Tips>>https://chatgpt.com/c/67d66d62-3244-800a-8974-570f38118948#tips]]
16 +
8 8  ----
9 9  
19 +== πŸ“Ž Attachments and Images ==
10 10  
11 -== Getting Started with XWiki ==
12 -If you would like to add content to the wiki, you can do so as a guest, but some of your options will be limited. its recommended to create an account and post that way. If you want to contribute but dont know where to start or you're overwhelmed by the options, the global dashboard will always be updated with whats being worked on currently. to see all the categories and pages we currently have, go here. IMAGE
13 -Adding content should be relegated to these main categories, or new ones that you want to create. You shouldn't need to edit any pages outside of it for the most part, they may be linked elsewhere as resources for you, but they wont be editable. If you just have some pictures you would like to add to a topic, attach them at the bottom of the page and they will be automatically included in the gallery on the page if it has one. Changes or content added can always be revised to an earlier version easily, so don't be concerned with unwanted additions or edits. You can use the sandbox to experiment with formatting.
21 +You can easily upload files and images directly from the WYSIWYG editor:
14 14  
15 -On top of the category content, there are also applications that allow you to take part in the wiki via many other avenues. There is a forum, AI is in the works, Ideas, Suggestions for improvements, A Visualizer, Music Library, Research Papers collection, and many other things, as well as new extensions being added often. The message of the day will alert you to some of the things ive been working on or have finished recently. If you would like to have your Pro White group listed here let me know and I'll add it so others can join with you and network. This has thus far been mostly a solo undertaking, so I apologize if things break for extended times, I assure you I'm working on them when I can, but I have other things to attend to as well. There is typically daily changes and updates being made.
23 +**Uploading Attachments:**
16 16  
17 -== πŸ” **Useful Tips & Best Practices** ==
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.
18 18  
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 +----
37 +
38 +== ⚑ Using the / Macro Shortcut ==
39 +
40 +The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
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 +----
54 +
55 +== ✏️ Basic Formatting and Links (Quick Guide) ==
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.
62 +
63 +----
64 +
65 +== πŸ” Useful Tips & Best Practices ==
66 +
67 +* **Save drafts frequently:** Press Ctrl+S regularly.
19 19  * **Macros** greatly simplify content formattingβ€”use / often.
20 -When to insert an image rather than upload the image: Upload the image at the bottom of the page via the built in extension if you just want to post the image without context. This is always acceptable on any page given that it is relevant. Embed an image when you are adding context to it or using it to reinforce some context already present. Same with videos.
69 +* **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them.
21 21  * **Use minimal formatting** to ensure readability.
22 22  
23 23  ----
24 24  
25 -= ⚑**Guests can contribute** =
74 += ⚑Guests can contribute =
26 26  
27 27  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.
28 28  1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
29 29  1. Leave comments, give suggestions, request features.
30 30  
31 -== **Content Guidelines** ==
80 +== Content Guidelines ==
32 32  
33 33  * 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.
34 34  * 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.
35 35  
85 +== Directories and Page URLs ==
36 36  
37 -== **XWiki Editing Modes** ==
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.
38 38  
89 +Here’s a consolidated guide tailored for your XWiki environment, integrating essential syntax, formatting options, and an overview of notable macros to enhance content creation and management.ξˆ†
90 +
91 +**1. XWiki Editing Modes**
92 +
39 39  XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:ξˆ†
40 40  
41 -* **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.
42 -* **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.
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.ξˆ†
43 43  
44 -== **Essential Formatting Options** ==
99 +**Switching Between Syntaxes**
45 45  
46 -To ensure content is both engaging and accessible, utilize the following formatting techniques:
101 +XWiki supports multiple syntaxes, including XWiki 2.1, MediaWiki, and others. While it’s possible to switch a page’s syntax, exercise caution, as certain syntaxes may not fully support WYSIWYG editing. For instance, changing a page to MediaWiki syntax might limit the availability of the WYSIWYG editor. ξˆ€citeξˆ‚turn0search6ξˆξˆ†
47 47  
48 -* **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.4
103 +**2. Essential Formatting Options**
49 49  
105 +To ensure content is both engaging and accessible, utilize the following formatting techniques:ξˆ†
106 +
107 +*. **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.ξˆ†
108 +
109 +
50 50  {{code}}
51 51   + Heading Level 1
52 52   ++ Heading Level 2
... ... @@ -53,236 +53,156 @@
53 53   +++ Heading Level 3
54 54  {{/code}}
55 55  
116 +ξˆ†
56 56  
57 -== **Links** ==
118 +*. **Text Formatting**: Apply styles such as bold, italics, and underlining to emphasize text.ξˆ†
58 58  
120 +**. **Bold**: Surround text with double asterisks.ξˆ†
59 59  
60 60  
61 -==== **Internal Link**: Use square brackets with the page name. ====
62 -{{example}}
63 63  {{code}}
64 -[[PageName]]
124 +**bold text**
65 65  {{/code}}
66 -{{/example}}
126 +**. **Italics**: Use double underscores.ξˆ†
67 67  
68 68  
69 -==== **External Link**: Provide the URL directly. ====
70 -{{example}}
71 71  {{code}}
72 -[https://www.example.com]
130 +__italic text__
73 73  {{/code}}
74 -{{/example}}
132 +**. **Underline**: Enclose text with double tildes.ξˆ†
75 75  
76 76  
77 -== ⚑ **Using the / Macro Shortcut** ==
135 +{{code}}
136 +~~underlined text~~
137 +{{/code}}
138 +*. **Lists**: Create ordered and unordered lists for structured information.ξˆ†
78 78  
79 -The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
140 +**. **Unordered List**: Begin lines with asterisk (*) or hyphen (-).ξˆ†
80 80  
81 -* Simply type / and start typing the macro name or feature you want to add.
82 -* You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
83 -* Example macros include:
84 -** /toc – Table of Contents
85 -** /box – Insert Box Macro
86 -** /gallery – Image Gallery
87 -** /footnote – Add footnotes to your text
88 -** /code – Code blocks for programming snippets
89 89  
90 -This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax
143 +{{code}}
144 +* Item 1
145 +* Item 2
146 +{{/code}}
147 +**. **Ordered List**: Start lines with a number followed by a period.ξˆ†
91 91  
92 -----
93 -= πŸ“š Macro Examples & Formatting Guide =
94 94  
95 -== πŸ§ͺ Macro Showcase: Source + Output + Slash Command ==
150 +{{code}}
151 +1. First item
152 +2. Second item
153 +{{/code}}
154 +*. **Links**: Insert internal and external links to connect related content.ξˆ†
96 96  
97 -All macros are shown with the WYSIWYG `/command`, an expandable explanation, and an editable source/output block using example
156 +**. **Internal Link**: Use square brackets with the page name.ξˆ†
98 98  
99 -----
100 100  
101 -== Table of Contents Macro (`/toc`) ==
159 +{{code}}
160 +[[PageName]]
161 +{{/code}}
162 +**. **External Link**: Provide the URL directly.ξˆ†
102 102  
103 -{{expandable summary="πŸ“˜ Table of Contents Macro (`/toc`)"}}
104 -{{example}}
105 -{{toc/}}
106 -{{/example}}
107 -{{/expandable}}
108 108  
109 -----
165 +{{code}}
166 +[https://www.example.com]
167 +{{/code}}
168 +*. **Images**: Embed images to enrich content.ξˆ†
110 110  
111 -== Gallery Macro (`/gallery`) ==
112 112  
113 -{{expandable summary="πŸ–ΌοΈ Gallery Macro (`/gallery`)"}}
114 -{{example}}
115 -{{gallery}}
116 -[[1747262485678-297.png]]
117 -[[image:photo2.jpg]]
118 -{{/gallery}}
119 -{{/example}}
120 -{{/expandable}}
171 +{{code}}
172 + [[image:example.jpg]]
173 +{{/code}}
121 121  
122 -----
175 +ξˆ†
123 123  
124 -== Carousel Macro (`/carousel`) ==
177 +**3. Utilizing XWiki Macros**
125 125  
126 -{{expandable summary="πŸ“½οΈ Carousel Macro (`/carousel`)"}}
127 -{{example}}
128 -{{carousel/}}
129 -{{/example}}
130 -{{/expandable}}
179 +Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:ξˆ†
131 131  
132 -----
181 +1. **Box Macro**: Encapsulates content within a styled box, useful for highlighting information.ξˆ†
133 133  
134 -== Box Macro (`/box`) ==
135 135  
136 -{{expandable summary="πŸ“¦ Box Macro (`/box`)"}}
137 -{{example}}
138 -{{box cssClass="highlight"}}
139 -Insert your highlighted content here.
184 +{{code}}
185 +{{box}}
186 +Your content here.
140 140  {{/box}}
141 -{{/example}}
142 -{{/expandable}}
188 +{{/code}}
143 143  
144 -----
190 +ξˆ†
191 +1. **Info Macro**: Displays an informational message, often used for tips or notes.ξˆ†
145 145  
146 -== Info and Warning Boxes (`/info`, `/warning`) ==
147 147  
148 -{{expandable summary="⚠️ Info and Warning Macros (`/info`, `/warning`)"}}
149 -{{example}}
150 -{{info}}This is an info box.{{/info}}
194 +{{code}}
195 +{{info}}
196 +This is an informational note.
197 +{{/info}}
198 +{{/code}}
151 151  
152 -{{warning}}This is a warning box.{{/warning}}
153 -{{/example}}
154 -{{/expandable}}
200 +ξˆ†
201 +1. **Warning Macro**: Highlights warnings or important notices.ξˆ†
155 155  
156 -----
157 157  
158 -== Footnotes (`/footnote`, `/put footnotes`) ==
204 +{{code}}
205 +{{warning}}
206 +Caution: Proceed with care.
207 +{{/warning}}
208 +{{/code}}
159 159  
160 -{{expandable summary="🧾 Footnote + PutFootnotes (`/footnote`, `/put footnotes`)"}}
161 -{{example}}
162 -This is a footnoted statement{{footnote}}https://www.example.com{{/footnote}}.
210 +ξˆ†
211 +1. **Code Macro**: Renders code snippets with syntax highlighting.ξˆ†
163 163  
164 -{{putFootnotes/}}
165 -{{/example}}
166 -{{/expandable}}
167 167  
168 -----
169 -
170 -== Expandable Macro (`/expandable`) ==
171 -
172 -{{expandable summary="🧩 Expandable Macro (`/expandable`)"}}
173 -{{example}}
174 -{{expandable summary="Click to expand"}}
175 -This content is hidden until clicked.
176 -{{/expandable}}
177 -{{/example}}
178 -{{/expandable}}
179 -
180 -----
181 -
182 -== Embed Macro (`/embed content`) ==
183 -
184 -{{expandable summary="🌐 Embed Macro (YouTube etc.) (`/embed content`)"}}
185 -{{example}}
186 -{{embed url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
187 -{{/example}}
188 -{{/expandable}}
189 -
190 -----
191 -
192 -== Code Macro (`/code`) ==
193 -
194 -{{expandable summary="πŸ’» Code Block Macro (`/code`)"}}
195 -{{example}}
214 +{{code}}
196 196  {{code language="python"}}
197 197  def hello_world():
198 198   print("Hello, world!")
199 199  {{/code}}
200 -{{/example}}
201 -{{/expandable}}
219 +{{/code}}
202 202  
203 -----
221 +ξˆ†
222 +1. **Gallery Macro**: Creates an image gallery from attached images.ξˆ†
204 204  
205 -== Image Insert (`[[image:...]]`) ==
206 206  
207 -{{expandable summary="πŸ–ΌοΈ Image Macro (`[[image:filename.jpg]]`)"}}
208 -{{example}}
209 -[[image:1747262485678-297.png]]
210 -{{/example}}
211 -{{/expandable}}
225 +{{code}}
226 +{{gallery}}
227 +[[image1.jpg]]
228 +[[image2.jpg]]
229 +{{/gallery}}
230 +{{/code}}
212 212  
213 -----
232 +ξˆ†
233 +1. **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings.ξˆ†
214 214  
215 -== Audio Embed (HTML tag or `/embed JWPlayer`) ==
216 216  
217 -{{expandable summary="πŸ”Š Audio Embed (`<audio>` tag or `/embed JWPlayer`)"}}
218 -{{example}}
219 -{{html}}
220 -<audio controls>
221 - <source src="/bin/download/Sandbox/TestPage2/Anti-Black%20racial%20slur%20was%20found%20written%20on%20high%20school%20desk%20in%20Rockville.mp3" type="audio/mpeg">
222 - Your browser does not support the audio element.
223 -</audio>
224 -{{/html}}
225 -{{/example}}
226 -{{/expandable}}
236 +{{code}}
237 +{{toc/}}
238 +{{/code}}
227 227  
228 -----
240 +ξˆ†
241 +1. **Include Macro**: Embeds content from another page.ξˆ†
229 229  
230 -== Video Embed Macro (`/video`) ==
231 231  
232 -{{expandable summary="🎬 Video Macro (`/video`)"}}
233 -{{example}}
234 -{{video url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"/}}
235 -{{/example}}
236 -{{/expandable}}
244 +{{code}}
245 +{{include reference="PageName"/}}
246 +{{/code}}
237 237  
238 -----
248 +ξˆ†
249 +1. **Display Macro**: Displays the content of another document or an object property.ξˆ†
239 239  
240 -== Full Example: Expandable Study Summary (`/expandable`) ==
241 241  
242 -{{expandable summary="πŸ“š Full Use Case – Study Summary Macro (`/expandable`)"}}
243 -{{example}}
244 -{{expandable summary="Study: The Wilson Effect"}}
245 -**Source:** *Twin Research and Human Genetics (2013)*
246 -**Author:** *Thomas J. Bouchard Jr.*
247 -**DOI:** [10.1017/thg.2013.54](https://doi.org/10.1017/thg.2013.54)
252 +{{code}}
253 +{{display reference="PageName"/}}
254 +{{/code}}
248 248  
249 -{{expandable summary="πŸ“Š Key Statistics"}}
250 -- IQ heritability rises to **0.80** by adulthood
251 -- Shared environment drops to **0.10**
252 -{{/expandable}}
256 +ξˆ†
257 +1. **Velocity Macro**: Executes Velocity scripts for dynamic content generation.ξˆ†
253 253  
254 -{{expandable summary="πŸ”¬ Findings"}}
255 -- Genetic influence strengthens over time
256 -- Monozygotic twins’ IQ similarity increases with age
257 -{{/expandable}}
258 258  
259 -{{expandable summary="πŸ“ Critique & Observations"}}
260 -- Strength: Large dataset, longitudinal
261 -- Limitation: Mostly Western countries
262 -{{/expandable}}
260 +{{code}}
261 +{{velocity}}
262 +#set($greeting = "Hello, $user.name!")
263 +$greeting
264 +{{/velocity}}
265 +{{/code}}
263 263  
264 -{{expandable summary="πŸ“Œ Relevance"}}
265 -- Strong support for genetic IQ theories
266 -- Diminishing environmental influence
267 -{{/expandable}}
268 -
269 -{{expandable summary="πŸ“„ Download"}}
270 -[[Download Full Study>>attach:10.1017_thg.2013.54.pdf]]
271 -{{/expandable}}
272 -
273 -{{/expandable}}
274 -{{/example}}
275 -{{/expandable}}
276 -
277 -----
278 -
279 -== Bonus: Boilerplate Example Template ==
280 -
281 -{{expandable summary="πŸ“‹ Example Macro Template (`/example`)"}}
282 -{{example}}
283 -{{example}}
284 -Your macro goes here.
285 -{{/example}}
286 -{{/example}}
287 -{{/expandable}}
288 -
267 +ξˆ†
268 +1. **HTML Macro**: Allows the inclusion of
1747262485678-297.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.AdminAngriff
Size
... ... @@ -1,1 +1,0 @@
1 -1.6 MB
Content