自治Lab How To (changes)

Last revised on September 19, 2024 at 13:40:33. See the history of this page for a list of all contributions to it.

Showing changes from revision #1 to #2: Added | Removed | Changed

Coming soon.

Selfrule Lab?: The How-To Guide

Welcome to the comprehensive guide on using Selfrule Lab? effectively. Whether you’re a seasoned editor or a new contributor, understanding the platform’s features and conventions will enhance your experience and improve the platform’s collective knowledge.

Getting Started

Starting a New Page in selfruleLab

To initiate a new page on selfruleLab, follow the steps below:

  1. Request a Link to the New Page:

    1. Choose an existing selfruleLab page that should link to your new page. If unsure, default to the Sandbox page.
    2. Click “edit” on your chosen page.
    3. In the editing pane, insert: [[your new page name]] where appropriate, preferably in the “Related entries” section.
    4. Click “submit”. If the page named [[your new page name]] doesn’t exist yet, it’ll be shown in gray with a clickable question mark next to it.
  2. Create the New Page:

    1. Click on the gray question mark to open the new page’s editing pane.
    2. Add your content and then click “submit”.
    3. You can iterate through “Submit” and “Edit” until you’re satisfied. There’s no preview option.

Notes: - Page names are case-sensitive. If the link starts a sentence, use lowercase, e.g., [[like this|Like this]]. It’s a loose convention in selfruleLab. - Utilize [[redirects]] for alternative case usages in links. - When editing, include your name after ‘Submit as’. Otherwise, it defaults to ‘Anonymous’. - Your name, when added for the first time, appears at the page’s bottom in gray with a question mark, suggesting the creation of a user page. It’s optional.

Creating a User Page:
After editing, you can click the question mark next to your name at the bottom to set up a user page. If you want to create a user page without editing first, make a minor change to the Sandbox. Your name will then appear at the bottom, allowing you to click the question mark and proceed.

Editing Pages on selfruleLab

  1. Click “edit page” to view the page’s code.
  2. Use the [[Sandbox|Sandbox]] for practice.
  3. Create links by placing them in [[double brackets]].
  4. After making edits, click “submit”. There’s no preview feature.
  5. If you submit twice within 30 minutes using the same signature, it’s counted as one edit.

Merging Pages on selfruleLab

Occasionally, you might want to merge content from two existing pages A and B, especially if a page was unintentionally duplicated. Before proceeding, consider discussing the merge on the selfruleLab Forum to get consensus.

If you decide to proceed:

  1. Merge Content into Page A:

    1. Edit A to incorporate the desired content from B.
    2. Add “[[!redirects B]]” at the bottom. If B has any “[[!redirects X]]” directives, transfer them to A.
    3. Submit your changes.
  2. Orphan Page B:

    1. Clear its content (e.g., using Ctrl-A Del).
    2. Tick ‘Change page name’, and in the ‘New name’ field, append “> history” to “B”, making it “B > history”.
    3. In the editing area, the line “[[!redirects B]]” may auto-populate. Remove it and add “see [[A]]”.
    4. In the announcement box below the edit box, note the reason for your edit, e.g., “Merged content into page "A" and orphaning this page.
    5. Submit the changes.

Note: selfruleLab doesn’t allow regular users to delete pages. Instead, they’re “orphaned”.

Organizing and Writing Content on selfruleLab

How to use redirects

See redirects?.

Page Organization

We advise authors to categorize content using sections and subsections, mirroring the * Template page?.

Although pages begin small, they expand over time. Structured subsections aid in comprehending content, especially in a collaborative setting, guiding authors on where to add new content. Think of selfruleLab more as an encyclopedia than a storybook.

  • Interlinking is a cornerstone of Selfrule Lab?. Content gains value when it’s connected to related information within the platform.

  • Hyperlink central keywords by enclosing them in square brackets. Aim to link each keyword, especially upon its first occurrence. Never assume the reader’s background aligns with yours. When introducing technical terms, always provide links to Selfrule Lab? entries that define them.

  • When creating a new page, ensure it’s linked from at least one other pertinent page. This assists both users in navigating and search engines in indexing Selfrule Lab?, making new entries more discoverable through related searches.

A key aspect of selfruleLab is interconnectedness. Adding unlinked information doesn’t maximize its value. Always hyperlink central keywords, especially upon their first mention, to ensure readers from varying backgrounds can follow.

Furthermore, newly created pages should be linked from at least one pertinent page. For instance, a new type of manifold should be linked from the “related entries” on the _? page.

Such interlinking not only aids users but also optimizes selfruleLab’s visibility on search engines.

How to Cite and Record References in SelfruleLab

At the conclusion of each Selfrule Lab? entry, include a section titled:

## References

or, alternatively,

## Literature

This section should contain a list of pertinent references. Follow the standardized format below for each entry in the list:

* {#LastnameAnotherlastnameYear} [[Firstname Lastname]], [[Anotherfirstname Anotherlastname]], _Title_, Journal, volume, year ([arXiv:xxxx.yyyyy](https://arxiv.org/abs/xxxx.yyyyy), [doi:xyz](http://doi.xyz))

When rendered, this appears as:

Firstname Lastname, Anotherfirstname Anotherlastname, Title, Journal, volume, year (arXiv:xxxx.yyyyy, doi:xyz)

To reference the above citation in the main content of the entry, use:

see ([Lastname-Anotherlastname Year](#LastnameAnotherlastnameYear))

Upon rendering, this becomes:

see (Lastname-Anotherlastname Year)

Using this format creates a clickable hyperlink that, when accessed, highlights the related reference in a gray box.

Special Typesetting Features on selfruleLab

Linking to Subsections and Blocks

  • To define a section with a linkable anchor:
    ## Heading {#anchorname}

Linking to Subsections

  1. Creating Section Headers with Anchors: ## Heading {#anchorname}

  2. Linking to the Section:

    • Within the same page: [link text](#anchorname)
    • Different page: [[some page#anchorname|link text]]
    • External link: Add http://selfrulelab.org before the link.
  3. Linking to Text Blocks:

    • Add anchor at start: * {#xyz} Reference
    • Link within the same page: [link text](#xyz)

Equations

  1. Automatic Numbering:

  2. Label & Refer:

  • Add label: \label{SomeEquation}\exp(\pi i) + 1 = 0
  • Refer later: See equation \eqref{SomeEquation}.

Creating a Standout Box in selfruleLab

To emphasize important text using a standout box:

+-- {: .standout}
Your standout content here
=--

Adding a Floating Table of Contents in selfruleLab

For a floating TOC that auto-collapses until hovered over, use:

+-- {: .rightHandSide}
+-- {: .toc .clickDown tabindex="0"}
### Context
#### Category Theory
+-- {: .hide}
[[!include category theory - contents]]
=--
=--
=--

Creating Visual Content in SelfRuleLab

1. Xymatrix Diagrams

In Self Rule Lab?, you can use the xymatrix command, similar to La Te X?, for commutative diagrams. Keep in mind:

  • Use <nowiki>\begin{xymatrix} ... \end{xymatrix}</nowiki> instead of \xymatrix{...}.
  • Pass parameters within the <nowiki>\begin{xymatrix}</nowiki> tag. For spacing, utilize commands like @=1.5em or @C and @R for columns and rows respectively. You can also use square brackets for parameters, e.g., <nowiki>\begin{xymatrix[font = \large, border = 2em]}</nowiki>.

Internally, the process involves converting La Te X? to SVG for rendering.

For those unfamiliar with Xymatrix and Tikz, it’s recommended to choose Tikz. However, using Xymatrix is perfectly acceptable if you’re accustomed to it.

Examples:

Triangle:

\begin{centre} \begin{xymatrix} A \ar[r] \ar[dr] & B \ar[d] \\ & C \end{xymatrix} \end{centre>

\begin{centre} \begin{xymatrix[border = 2pc]} A \ar@/^2.0pc/[r] \ar@/_2.0pc/[r] & B \end{xymatrix} </end>

2. Image Files

To embed images in Self Rule Lab?:

  • Insert <nowiki>[[image_name.jpg:pic]]</nowiki> or <nowiki>[[display_text|image_name.jpg:pic]]</nowiki> on the page, then save.
  • Click on the ? symbol next to the image name or display text.
  • You’ll be redirected to a page where you can upload the image.

After uploading, the :pic tag allows limited configurations. Alternatively, utilize the imagefromfile block, as shown:

Basic Image:

\begin{imagefromfile} "file_name": "FileName.xyz" \end{imagefromfile}

Image with Margin:

\begin{imagefromfile} "file_name": "FileName.xyz", "float": "right", "margin": { "top": -40, "right": 0, "bottom": 20, "left": 20 } \end{imagefromfile>

Full Image Options:

\begin{imagefromfile} "file_name": "FileName.xyz", "web": "selfrulelab", "width": 300, "height": 300, "unit": "px", "float": "right", "margin": { "top": -40, "right": 0, "bottom": 20, "left": 20, "unit": "px" }, "alt": "Sample Image", "caption": "Description of the Image" \end{imagefromfile>