Help:Editing

From CMU -- Language Technologies Institute -- HPC Wiki
Jump to navigation Jump to search


Editing Pages

[edit source]

To maintain consistency, let's try to adhere to the following conventions and guidelines:

Understanding Wiki Markup

[edit source]

MediaWiki uses a lightweight markup language called Wiki Markup to format and structure content. Here are a few essential elements:

  • Headings: Use equal signs = to create headings. For example, === Section Title === creates a third-level heading.
  • Bold and Italic: Enclose text in triple apostrophes ''' for italics and double apostrophes '' for bold. For example, ''italic text'' and '''bold text'''.
  • Lists: Create bulleted lists using asterisks * or numbered lists using hash symbols #.
  • Links: Enclose the text in double square brackets [[ ]] to create a link to another page. For example, [[Page Title]] links to the page titled "Page Title".
  • Citing Sources and References: Use the <ref> </ref> tags to create footnotes and references.
  • Linking to Other Pages: Whenever possible, link relevant terms or topics to existing pages within the wiki to provide more context and facilitate navigation.
  • Collaboration and Communication: Take advantage of talk pages and discussion forums to communicate with other editors, ask questions, and seek feedback.

Creating a New Page

[edit source]

To create a new page, follow these steps:

  1. Log In: Log in to your MediaWiki-based wiki using your credentials. You will need appropriate permissions to create new pages.
  2. Navigate to the Main Page: Once you're logged in, you'll typically start on the main page of your wiki.
  3. Search for the Page: Use the search bar on the wiki to search for the page you want to create. If the page doesn't exist, the search results will indicate that.
  4. Click on the Red Link: In the search results, you'll likely see a red link with the title of the page you want to create. This red link indicates that the page does not exist yet.
  5. Edit the New Page: Click on the red link to start creating the new page. This will take you to the editing interface.
  6. Add Content: Use the editing tools to add and format your content. You can use wiki markup, which is a set of formatting codes, to structure your page. For example, to create a heading, use "== Heading ==".
  7. Preview and Save: Before saving the page, you can click the "Preview" button to see how it will look. This allows you to review and make any necessary changes.
  8. Add a Summary: Below the editing area, there is usually a field to add an edit summary. It's a good practice to provide a brief description of the changes you've made.
  9. Save the Page: After previewing and ensuring everything is as you want it, click the "Save page" button to create the new page.
  10. Link to the New Page: Once the page is saved, it will become a part of your wiki. You can now link to it from other pages by creating links using double square brackets, like New Page Title.
  11. Categorize (Optional): You can also categorize your new page by adding category tags at the bottom of the page. This helps organize content within your wiki.
  12. Collaborate and Maintain: Collaborate with others to update and maintain the new page as needed. You can continue to edit and improve the content over time.

Editing a Page

[edit source]

We are offering two main editing modes: the Visual Editor and the Source Editor.

Visual Editor

[edit source]

The Visual Editor provides a WYSIWYG (What You See Is What You Get) interface, allowing you to edit pages in a more intuitive and visual manner. Here's how to use the Visual Editor:

  1. Accessing the Visual Editor: To open the Visual Editor, click on the "Edit" tab at the top of a page. If the Visual Editor is available on your wiki, you'll see an option to switch to it.
  2. Editing Content: In the Visual Editor, you can directly edit the content on the page as you would in a word processor. Use the toolbar at the top to format text, create headings, add links, insert images, and perform other common editing tasks.
  3. Inserting Links and Media: To insert a link, select the text you want to link and click on the "Link" button in the toolbar. To add images or other media, click on the "Insert" button and select the appropriate option.
  4. Table Editing: To create or modify tables, click on the "Table" button in the toolbar. You can add or remove rows and columns, adjust cell properties, and format the table to suit your needs.
  5. Citation Management: The Visual Editor provides options for managing citations. You can use the "Cite" button in the toolbar to add or modify references, including inline citations and a reference list.
  6. Preview and Save: Once you've made your changes, click on the "Show preview" button to see how the page will look. If everything appears as desired, click on "Save page" to publish your changes.

Source Editor

[edit source]

The Source Editor allows you to directly edit the wiki markup of a page. This editor provides more flexibility and control over the page's formatting and structure. Here's how to use the Source Editor:

  1. Accessing the Source Editor: To open the Source Editor, click on the "Edit source" tab at the top of a page. This will display the page's source code.
  2. Editing Markup: In the Source Editor, you can modify the wiki markup directly. Familiarize yourself with common wiki markup syntax, such as headings, bold/italic text, lists, links, and templates, to format and structure the content.
  3. Saving Changes: After making edits in the Source Editor, click on the "Show preview" button to preview the page. Ensure your changes are displayed correctly. If satisfied, click on "Save page" to publish your edits.

See Also

[edit source]