0 Votes

Changes for page Start here if you're new

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

From version 1.3
edited by Ryan C
on 2025/03/15 22:03
Change comment: Update document after refactoring.
To version 10.1
edited by Ryan C
on 2025/03/16 01:21
Change comment: There is no comment for this version

Summary

Details

Page properties
Syntax
... ... @@ -1,1 +1,1 @@
1 -Markdown 1.2
1 +XWiki 2.1
Content
... ... @@ -1,43 +1,277 @@
1 -# Quick Start
1 += =
2 2  
3 -Welcome to The White Archive! This guide will provide you with all the necessary information to contribute effectively to the wiki. This first page is all you need to know regarding the basic sign in process and introductory asset management. Scroll to the bottom for more detailed information on these things.
3 +----
4 4  
5 -1. **Create a Throwaway Email** You can get a [throwaway](https://temp-mail.org/en/) email and sign up with it. I dont think people should have to make an account to add things but its a limitation of the system.
6 -1. **Create an Account:** Sign up to access editing and page creation tools. Upon account creation you can immediately sign in and start editing and adding pages. You do **NOT** need to verify your email first. .
7 -1. **Use Your Sandbox:** Test and draft your content in your personal sandbox. Visit [Your Sandbox](/en/sandbox)
8 -1. **Unique Page Titles:** Avoid duplication by giving your pages specific, descriptive names. Use only lowercase in your path definitions.
9 -1. **Link Your Pages:** Connect related topics by adding internal links to your content.
10 -1. **Submit Your Work:** Your page will be available immediately upon publishing.
5 +== Getting Started with XWiki ==
11 11  
12 -## Content Guidelines
7 +This page covers all the essential steps and tips you need to create great content in XWiki without any confusion.
13 13  
14 -* 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](/science-and-research/race-and-iq) 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.
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.
15 15  * 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.
16 16  
17 -## Directories and Page URLs
81 +== **Directories and Page URLs** ==
18 18  
19 -* Organize content under appropriate categories. For example, a page about racial demographics should be placed under `/en/race-and-demographics/` [[![[a|categoriesthumb\.jpg.WebHome]]|doc:categories\.jpg.WebHome]]
20 -* Use descriptive and concise URLs for pages. For instance, `/en/race-and-demographics/common-myths`.
21 -* Be mindful of page hierarchy: <strong style="color: red;">It is not necessary to nest deeper than the Original Category.</strong>
22 - * Pages directly under a category (e.g., `/en/race-and-demographics`) can use relative links like `[common myths](common-myths)`.
23 - * Nested pages (e.g., `/en/race-and-demographics/white-genocide/intent`) require full paths like `[intent](/en/race-and-demographics/white-genocide/intent)` for links to work correctly. I'm only including this in case you think a deeper more specific link is necessary. The example here makes sense to have nested that deep, but many pages can likely just be generalized under a main category. Keep in mind, its easy to change the location of pages, so dont worry about placing it in the perfect category or under the ideal page, just create it and let things come together as more content emerges.
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.
24 24  
25 -## Uploading and Accessing Assets
26 26  
27 -To upload an asset, use the Uploads section in the wiki interface. Ensure that files are named descriptively,
28 28  
29 -Tthe default path for uploads of any type will be just / if they are in the base directory.
87 +== **XWiki Editing Modes** ==
30 30  
31 -You can also highlight the segment you want to turn into an image or pdf and click insert image or insert link and it will create the link for you.
89 +XWiki offers multiple editing modes to accommodate various user preferences and technical requirements:
32 32  
33 -[[![[f6omxickm4_thumb.png|images.f6omxickm4_thumb\.png]]|doc:images.f6omxickm4\.png]]
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.
34 34  
35 -This is all you need to know to start out with. Explore below for more advanced formatting possibilities.
95 +=== **Switching Between Syntaxes** ===
36 36  
37 -## See Also
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
38 38  
39 -* [[Uploads and Scripts|doc:en.admin.uploads-and-scripts]]: Learn how to upload assets and automate tasks.
40 -* [[FAQs|doc:en.admin.faqs]]: Frequently asked questions and quick answers.
41 -* [Formatting Guide](/admin/contribute/formatting-the-basics):
42 - * [A More Comprehensive Guide](/admin/contribute/formatting-advanced)
43 -* [[Coding and Technical Setup|doc:en.admin.coding]]: Advanced setup guides and troubleshooting tips.
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 +** (((
118 +=== **Bold**: Surround text with double asterisks. ===
119 +)))
120 +
121 +{{code}}
122 +**bold text**
123 +{{/code}}
124 +
125 +
126 +*
127 +** (((
128 +=== **Italics**: Use double underscores. ===
129 +)))
130 +
131 +{{code}}
132 +__italic text__
133 +{{/code}}
134 +
135 +
136 +*
137 +** (((
138 +=== **Underline**: Enclose text with double tildes. ===
139 +)))
140 +
141 +{{code}}
142 +~~underlined text~~
143 +{{/code}}
144 +
145 +
146 +*
147 +** (((
148 +=== **Unordered List**: Begin lines with asterisk (*) or hyphen (-). ===
149 +)))
150 +
151 +{{code}}
152 +* Item 1
153 +* Item 2
154 +{{/code}}
155 +
156 +
157 +*
158 +** (((
159 +=== **Ordered List**: Start lines with a number followed by a period. ===
160 +)))
161 +
162 +{{code}}
163 +1. First item
164 +2. Second item
165 +{{/code}}
166 +
167 +
168 +== **Links** ==
169 +
170 +
171 +
172 +==== ** Internal Link**: Use square brackets with the page name. ====
173 +
174 +{{code}}
175 +[[PageName]]
176 +{{/code}}
177 +
178 +*
179 +** (((
180 +==== **External Link**: Provide the URL directly. ====
181 +)))
182 +
183 +{{code}}
184 +[https://www.example.com]
185 +{{/code}}
186 +
187 +* (((
188 +=== **Images** ===
189 +)))
190 +
191 +{{code}}
192 + [[image:example.jpg]]
193 +{{/code}}
194 +
195 +
196 +== **Utilizing XWiki Macros** ==
197 +
198 +Macros are powerful tools in XWiki that allow for dynamic content inclusion and advanced formatting. Here are ten notable macros to consider:
199 +
200 +**Box Macro**: Encapsulates content within a styled box, useful for highlighting information.
201 +
202 +{{code}}
203 +{{box}}
204 +Your content here.
205 +{{/box}}
206 +{{/code}}
207 +
208 +
209 +=== **Info Macro**: Displays an informational message, often used for tips or notes. ===
210 +
211 +{{code}}
212 +{{info}}
213 +This is an informational note.
214 +{{/info}}
215 +{{/code}}
216 +
217 +
218 +=== **Warning Macro**: Highlights warnings or important notices. ===
219 +
220 +{{code}}
221 +{{warning}}
222 +Caution: Proceed with care.
223 +{{/warning}}
224 +{{/code}}
225 +
226 +
227 +=== **Code Macro**: Renders code snippets with syntax highlighting. ===
228 +
229 +{{code}}
230 +{{code language="python"}}
231 +def hello_world():
232 + print("Hello, world!")
233 +{{/code}}
234 +{{/code}}
235 +
236 +
237 +=== **Gallery Macro**: Creates an image gallery from attached images. ===
238 +
239 +{{code}}
240 +{{gallery}}
241 +[[image1.jpg]]
242 +[[image2.jpg]]
243 +{{/gallery}}
244 +{{/code}}
245 +
246 +
247 +=== **TOC (Table of Contents) Macro**: Generates a table of contents based on page headings. ===
248 +
249 +{{code}}
250 +{{toc/}}
251 +{{/code}}
252 +
253 +
254 +=== **Include Macro**: Embeds content from another page. ===
255 +
256 +{{code}}
257 +{{include reference="PageName"/}}
258 +{{/code}}
259 +
260 +
261 +=== **Display Macro**: Displays the content of another document or an object property. ===
262 +
263 +{{code}}
264 +{{display reference="PageName"/}}
265 +{{/code}}
266 +
267 +
268 +=== **Velocity Macro**: Executes Velocity scripts for dynamic content generation. ===
269 +
270 +{{code}}
271 +{{velocity}}
272 +#set($greeting = "Hello, $user.name!")
273 +$greeting
274 +{{/velocity}}
275 +{{/code}}
276 +
277 +