0 Votes

Wiki source code of Start here if you're new

Version 8.1 by Ryan C on 2025/03/16 01:18

Show last authors
1 = =
2
3 ----
4
5 == Getting Started with XWiki ==
6
7 This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
8
9 == 📖 Table of Contents: ==
10
11 {{toc/}}
12
13 ----
14
15 == 📎 **Attachments and Images** ==
16
17 You can easily upload files and images directly from the WYSIWYG editor:
18
19 **Uploading Attachments:**
20
21 * Click **Edit** to enter the WYSIWYG editor.
22 * Click on the **Attachment** icon (📎 paperclip icon).
23 * Drag-and-drop or select your file to upload it instantly.
24 * Uploaded files will automatically be listed as attachments at the bottom of your page.
25
26 === **Inserting Images with Enlargable Thumbnails** ===
27
28 1. In the editor, click the **"Insert Image"** icon from the toolbar.
29 1. Upload or select the image.
30 1. Choose the **Thumbnail option** to create a clickable enlargable preview automatically.
31
32 ----
33
34 == ⚡ **Using the / Macro Shortcut** ==
35
36 The / macro shortcut is a powerful and quick way to insert macros while editing pages in XWiki's WYSIWYG editor:
37
38 * Simply type / and start typing the macro name or feature you want to add.
39 * You'll see suggestions appear as you type. Select the macro to insert it directly without manual syntax.
40 * Example macros include:
41 ** /toc – Table of Contents
42 ** /box – Insert Box Macro
43 ** /gallery – Image Gallery
44 ** /footnote – Add footnotes to your text
45 ** /code – Code blocks for programming snippets
46
47 This shortcut dramatically speeds up editing, no need to memorize complicated wiki syntax.
48
49 ----
50
51 == ✏️** Basic Formatting and Links (Quick Guide)** ==
52
53 * **Bold text**: Select text, click the **Bold** button or press Ctrl + B.
54 * **Italic text**: Select text, click "Italic" in the toolbar or use Ctrl+I.
55 * **Creating Links**:
56 ** Highlight text and click **"Link"** or use shortcut Ctrl+K.
57 ** Paste or select the page URL to link internally.
58
59 ----
60
61 == 🔍 **Useful Tips & Best Practices** ==
62
63 * **Save drafts frequently:** Press Ctrl+S regularly.
64 * **Macros** greatly simplify content formatting—use / often.
65 * **Edit attachments:** Hover attachments directly below your page in view mode to manage or delete them.
66 * **Use minimal formatting** to ensure readability.
67
68 ----
69
70 = ⚡**Guests can contribute** =
71
72 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.
73 1. Use Your Sandbox on the left, mess around with macros and other editing options. There's a lot of options to customize content.
74 1. Leave comments, give suggestions, request features.
75
76 == **Content Guidelines** ==
77
78 * 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.
79 * 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.
80
81 == **Directories and Page URLs** ==
82
83 * 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.
84
85
86
87 == **XWiki Editing Modes** ==
88
89 XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:
90
91 * **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
92 * **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.
93 * **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.
94
95 === **Switching Between Syntaxes** ===
96
97 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
98
99 == **Essential Formatting Options** ==
100
101 To ensure content is both engaging and accessible, utilize the following formatting techniques:
102
103 * **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.
104
105 {{code}}
106 + Heading Level 1
107 ++ Heading Level 2
108 +++ Heading Level 3
109 {{/code}}
110
111
112 === **Text Formatting** ===
113
114
115 *
116 ** (((
117 === **Bold**: Surround text with double asterisks. ===
118 )))
119
120 {{code}}
121 **bold text**
122 {{/code}}
123
124 *
125 ** (((
126 === **Italics**: Use double underscores. ===
127 )))
128
129 {{code}}
130 __italic text__
131 {{/code}}
132
133 *
134 ** (((
135 === **Underline**: Enclose text with double tildes. ===
136 )))
137
138 {{code}}
139 ~~underlined text~~
140 {{/code}}
141
142 *
143 *
144
145 *
146 ** (((
147 === **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
148 )))
149
150 {{code}}
151 * Item 1
152 * Item 2
153 {{/code}}
154
155 *
156 ** (((
157 === **Ordered List**: Start lines with a number followed by a period. ===
158 )))
159
160 {{code}}
161 1. First item
162 2. Second item
163 {{/code}}
164
165 * (((
166 === ===
167 )))
168 * (((
169 === **Links** ===
170 )))
171
172
173
174 ==== **Internal Link**: Use square brackets with the page name. ====
175
176 {{code}}
177 [[PageName]]
178 {{/code}}
179
180 *
181 ** (((
182 ==== **External Link**: Provide the URL directly. ====
183 )))
184
185 {{code}}
186 [https://www.example.com]
187 {{/code}}
188
189 * (((
190 === **Images** ===
191 )))
192
193 {{code}}
194 [[image:example.jpg]]
195 {{/code}}
196
197
198 == **Utilizing XWiki Macros** ==
199
200 Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
201
202 1. **Box Macro**: Encapsulates content within a styled box, useful for highlighting information.
203
204 {{code}}
205 {{box}}
206 Your content here.
207 {{/box}}
208 {{/code}}
209
210
211 === **Info Macro**: Displays an informational message, often used for tips or notes. ===
212
213 {{code}}
214 {{info}}
215 This is an informational note.
216 {{/info}}
217 {{/code}}
218
219
220 === **Warning Macro**: Highlights warnings or important notices. ===
221
222 {{code}}
223 {{warning}}
224 Caution: Proceed with care.
225 {{/warning}}
226 {{/code}}
227
228
229 === **Code Macro**: Renders code snippets with syntax highlighting. ===
230
231 {{code}}
232 {{code language="python"}}
233 def hello_world():
234 print("Hello, world!")
235 {{/code}}
236 {{/code}}
237
238
239 === **Gallery Macro**: Creates an image gallery from attached images. ===
240
241 {{code}}
242 {{gallery}}
243 [[image1.jpg]]
244 [[image2.jpg]]
245 {{/gallery}}
246 {{/code}}
247
248
249 === **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
250
251 {{code}}
252 {{toc/}}
253 {{/code}}
254
255
256 === **Include Macro**: Embeds content from another page. ===
257
258 {{code}}
259 {{include reference="PageName"/}}
260 {{/code}}
261
262
263 === **Display Macro**: Displays the content of another document or an object property. ===
264
265 {{code}}
266 {{display reference="PageName"/}}
267 {{/code}}
268
269
270 === **Velocity Macro**: Executes Velocity scripts for dynamic content generation. ===
271
272 {{code}}
273 {{velocity}}
274 #set($greeting = "Hello, $user.name!")
275 $greeting
276 {{/velocity}}
277 {{/code}}
278
279

XWiki AI Chat