Page last modified 00:57, 13 Nov 2011 by Dadeo

MediaPortal Wiki > Wiki Help > Contribute to Wiki > Edit a Page

Edit a Page

Was this page helpful?

1. Spelling
2. Rename a Page
3. Page Sections
4. Formatting Text
5. Tables
6. Inserting Content from other Wiki Pages (Transclusion)
7. Procedure
8. Document all Transcluded pages
1. 8.1. Add a Comment
2. 8.2. Tag the Page
9. Add Comments
10. Further Information

Edit any page by pressing Edit page on the Wiki menu. If you are looking for pages to edit, see our To Do Lists

Before you begin editing, make sure you are familiar with:

Almost all editing can be done using the Edit Menu functions. Learn them! Knowledge of HTML and web editors is helpful but not essential.

You do not need to format text, in fact you should keep formatting to a minimum (see Formatting Text below), but checking spelling would be appreciated.

Spelling

If not enabled, please enable spell check (proofread writing) on the Edit Menu. Usually the button with ABC and check mark.

The MediaPortal Wiki uses English US spell check, so thus, standard American English spellings.

Always spell check any document you create or edit.

Tip: MindTouch keeps changing the default Spell Check, and none of them are as good as browser spell checkers. If you have enabled 'Check Spelling' in your Firefox browser options/preferences you can use it while editing wiki pages:

Ctrl+right click - for browser context menu
Select Check Spelling from context menu
Ctrl+right click on any misspelled word

Works in Firefox so far.

Rename a Page

To rename a page, just edit the Page Title. You do not have to Edit a Page to edit the Page Title. Just hover your mouse over the page title and press Edit. Then edit the title in the Page Title box.

NOTE: There is a link to the right of the title which indicates if the TItle is synced to the URL. If it is synced, then when you change the Title, it will change the URL and move location in the Navigation Pane. Please be cautious and DO NOT sync the Title to the URL unless you really feel the page should be moved.

If you wish the name to appear differently in the URL and the Navigation Pane, you can press the red Sync button on the right of the Page Title box to keep the page title and URL in sync. Or you can edit the URL in the URL box. When you are done, just press the Update Title button.

Page Sections

You do not have to edit a whole page. You can edit just a section of the page if you wish. Just hover your mouse over the Section Heading and click the Edit button which appears.

Formatting Text

Generally, you should NOT format text very much. Do not alter:

fonts
font sizes
text colours (unless absolutely necessary)
text background colours
indent text (other than in lists)

These styles will be set in templates so any change to the template style will require manual editing of all your formatting.

You may, and should, use:

Headings for sections
Bulleted or numbered lists (never number lists manually)
Bold and Italics correctly (see Style Guide)

If you ever have a problem with layout (especially if copying/pasting text) you can always select the View button on the Edit Menu top row and edit the HTML source.

Tables

Tables are much improved in MindTouch 10. You should not need to format tables very much, as table style is set in the skin. However, you may wish to right click on a table and define a header row, which will shade the header row. You may also choose to shade odd or even lines.

Note: When entering multiple lines in table cells, be sure to use Shift+enter (break) to avoid formatting text as paragraphs (which indents them)

For further information on inserting and editing tables, see: Mind Touch User Manual > Getting Started > Insert Table Dialog

Inserting Content from other Wiki Pages (Transclusion)

You do not need to duplicate content in the MediaPortal Wiki. In fact, you should try to avoid it as much as possible.

Instead, you may transclude a page, or a section of a page in another page. This means the contents of that page, or page section will display on the other page. When the content is changed, or updated, the changes will then automatically display on any other page where it is transcluded.

Procedure

Press the Extensions button on the Edit Menu.
Select Built In Extensions.
Navigate to wiki.page (near the bottom).
Enter the parameters you wish.

Or you may use this format:

{{ wiki.page{path: "1_MEDIAPORTAL_1/15_Customization/003_Startup/2_Green_Button_Startup"} }}

or, for a section of a page:

{{ wiki.page{path: "1_MEDIAPORTAL_1/20_Reference/Folders_and_Files", section: "TV-Server log files"} }}

To include the heading of the source section:

{{ wiki.page{path: "Wiki_Help/4_Contribute_to_Wiki/1_Style_Guide", section: "Spelling", show: 1,
heading: "1"} }}

Do not enter the full URL - omit the "http://wiki.team-mediaportal.com/".

Note: In future we hope/plan to add Wiki.Page to the Insert option on the Edit Menu.

Note: Although it is possible to transclude only a section of a page, MindTouch does not track changes to section Headings, so your transclusion will fail if you edit the section name. It is much safer to create a separate page for content that is transcluded, and transclude the whole page.

Document all Transcluded pages

When editing content, it is very important to know if the content also displays on other pages, so you do not edit it in a way that will not work on the other page(s).

Add a Comment

Thus, you should enter an editor's comment, which displays only in Edit mode.

Type the text: "Note: This page has been transcluded on: [link to the page]".
Select the text.
Select Insert > Comment.

The comment will be highlighted in yellow and will not display when browsing the page.

Tag the Page

Whenever you transclude a page, change the stage:transclude tag to stage:transcluded, or remove the stage:transclude tag (if it exists) and add the tag stage:transcluded if it does not exist.

This will automatically add the page to our list of transcluced pages on the To Do: Transclude page.

Add Comments

You may add a comment to the page which will appear when editing a page, but not when viewing it. This is useful to provide instructions to other contributors regarding the content you have added.

Select the text you wish to add as a comment.
On the Edit Menu, select Insert > Comment.

Note: If you do not select text first, then Insert > Comment will insert a hidden comment that only displays when you hover over the text where you added the comment.