Help:Editing

From Altera Wiki
Jump to: navigation, search

This page is meant to help you get started in creating and editing web pages on the Altera Wiki. If you have suggestions for additional topics, feel free to add them here or to mention them in the Discussion tab.

SAVE OFTEN! If you leave the page that you're working on without saving it, your changes will be lost!

Contents

Edit an existing page

Most pages include a tab for editing the page once you've logged in. To practice editing Altera Wiki pages, please visit the Sandbox first.

  1. First, open the page you wish to edit. Try it out with the Sandbox now!
  2. Click on the "edit" tab at the top of the page. This will open an editing window that includes all the current text and images for the page, in a rich editor. The rich editor toolbar includes commonly used icons for editing text. We have enabled the rich editor view by default on the Altera Wiki to make it as easy as possible for the community to contribute.
    If you prefer to use Wiki markup language for a particular page, click on the "Wikitext" button in the rich editor toolbar. If you never want to use the rich editor toolbar, you can disable the rich editor by clicking "[Disable rich editor]" above the toolbar.
  3. When you've made some changes, take advantage of the Show Preview button at the bottom of the page. Clicking this button lets you see what the page will look like before you push your changes live.
  4. When you're done, enter a Summary of the changes you've made so that the community can easily see what you've done in the history tab. If you've just fixed a typo or a grammatical error, you can check "This is a minor edit."
  5. Click Save Page and your changes are live!

Create a new page

  1. First, search to see if a page by that title already exists. Enter the desired page title in the "search" box.
  2. If a page with that title does not exist, the results page will give you the option to create a page by that title. Click on the red text, and it will take you to the new page that you've just created. You can start editing immediately.

Upload files and images

You may wish to upload files to the Altera Wiki for the community to download and/or edit. You may also wish to add images to your wiki pages. For either of these actions, you'll need to know how to upload.

  1. Click "Upload file" in the toolbox in the left navigation.
  2. Enter the path to the document in the "Source filename" box. Note that only certain file types are allowed.
  3. Enter a "Destination filename." This will be the name of the page where your item is stored. Be sure to end the filename with the appropriate file type (.doc, .jpg, etc).
  4. Enter a "Summary" to make it easier for users to find your item.
  5. Choose the appropriate license type. Refer to the Wiki Rules if you have questions.
  6. You may choose to "Watch this file" if you want to know when people modify it. You may also choose to "Ignore any warnings" about your file type, but your file may not upload successfully.
  7. Click the Upload file button.

Once your file has been uploaded, you will be taken to your file's new page. It will have a name like "File:Test File.doc." If you wish to link to this page, or include an image from the page on a wiki page, be sure to note the page name.

Add an image to a web page

  1. First, upload the image to the Altera Wiki by following the steps above. Make a note of the the image's page.
  2. Open the page on which you wish to add the image. Place your cursor in approximately the location where you'd like the image to reside.
  3. Choose the "Insert/Edit Image" icon on the rich editor toolbar.
    Insert-edit-image.jpg
  4. Start typing the file name. You do not need to include the text "File:". You will see the file that you've uploaded appear in the Automatic search results. Choose the result you want. Enter a caption (which the user will see when they mouse over your image.) You can choose to add a frame to your image, and/or align it as it makes sense on your page. You can also choose to resize your image in the Width and Height boxes. Click OK.
  5. Your image will appear in your page.You can drag and drop it around the page to some degree, based on the parameters you've set when you uploaded it.
  6. Click Show preview and then if everything is correct,Save page to save your changes.

Try it out in the Sandbox now!

Link to a file on the Altera Wiki

If you choose to link to a file that you have (or someone else has) uploaded to the Altera Wiki, follow these steps:

  1. Note the page name of the uploaded file. It will be something like "File:Test File.doc".
  2. Open the page on which you wish to add the link to the file. Place the curser where you want the link to the file page to be created. (This process will add text to your page--do not hyperlink existing text.)
  3. Choose the "Insert/Edit Link" icon on the rich editor toolbar.
    Insert-edit-link.jpg
  4. In the "Link" box, type the exact name of the file page--for example, "File:Test File.doc". It may not appear in the Automatic Search Results, but have faith and click OK.
    NOTE: You must enter the EXACT name, including the "File:", capital letters, spaces, etc. If you do not enter the exact name, you will link to a different or nonexistent page.
  5. Click Show preview to check your link. If the link is red, that means that the file name was not entered correctly and the wiki is looking for a page with a different name. If the link is blue, then click Save page and then test it out to ensure it goes to the correct file.

Try it out in the Sandbox now!

Linking to Altera Wiki (internal) pages

To link to other pages within the Altera Wiki:

  1. Ensure that the page you want to link to exists, and take note of the page's exact title.
  2. Write the text on your page that will be hyperlinked to the page within the Altera Wiki. Highlight the text with your cursor.
  3. Click on the "Insert/Edit Link" button in the rich editor toolbar.
  4. Enter the title of the page that you wish to link to. Select it from the Automatic search results and click OK.
  5. Click Show preview to check your link. If the link is red, that means that the page name was not entered correctly and the wiki is looking for a page with a different name. If the link is blue, then click Save page and then test it out to ensure it goes to the correct page.

Try it out in the Sandbox now!

Linking to external web pages

  1. Ensure that the page you want to link to exists, and take note of the page's exact URL (including http://).
  2. Write the text on your page that will be hyperlinked to the external URL. Highlight the text with your cursor.
  3. Click on the "Insert/Edit Link" button in the rich editor toolbar.
  4. Enter the URL of the page that you wish to link to, including http://.
  5. Click Show preview to check your link. If the link is red, that means that the URL was not entered correctly and the wiki is looking for a page within the wiki. If the link is blue, then click Save page and then test it out to ensure it goes to the correct page. You will be asked to type two words in a "Captcha" box to prevent spam.

Try it out in the Sandbox now!

Categorizing / tagging your page

Once you've created your page, you want to make sure that people can find it. The Altera Wiki has pre-set categories, including Embedded Processing, DSP, Interfaces, Memory/Memory Controllers, Design Entry/Optimization, Timing/Verification, and Board Design/Configuration. To ensure that your page shows up in the correct Category page:
Insert-categories.jpg
  1. Click on the "Insert/Edit category" button in the rich editor toolbar.
  2. In the pop-up box, double-click on the applicable categories. Be as accurate as possible--more categories are not necessarily better, if your page doesn't really belong there.
  3. Click "OK."

You will see the selected categories at the bottom of your Wiki page, and your Wiki page will appear in the list of pages for that category.

Try it out in the Sandbox now!

Changing your page title

In a wiki, the page title determines the URL. So changing a page title moves the page to a new URL. Within the Altera Wiki, if other pages link to the old page title, then those links will be automatically redirected to the new page title. To change your page title:

  1. Go to the page. Click the "move" tab at the top of the page.
  2. Enter the new name for the page in the text box. If a page already exists with that title, the Wiki will not allow you to overwrite it.
  3. Usually you will want to "move the associated talk page," so leave that box checked.
  4. Click "Move page"

Your page will be moved to the new name. Searches for the old page name will automatically redirect to the new page name.

Embedding a video

Visit the Help:Embed a YouTube Video page for instructions.

Adding rating stars

To add the ratings (stars) to an article, simply add this Wikitext code to the top of the page (you must be in the Wikitext view, not the WYSIWYG view, of the editor.) Every logged on user can vote only once per username per article. 

{{#tag:ratings:scale||category="Articles"|title="{{PAGENAME}}"}}

 

Personal tools