Create a Page: Difference between revisions

From KDE UserBase Wiki
Line 21: Line 21:
Application/Manual/Section_1 <br />
Application/Manual/Section_1 <br />
Application/Manual/Section_xxx <br />
Application/Manual/Section_xxx <br />
{{Remember|1=<span  style="color:red;">Please do not use any kind of punctuation in your page names</span> &mdash; punctuation like question marks or periods creates serious problems for the wiki software, in particular for the translation system.}}


==Workflow==
==Workflow==

Revision as of 07:14, 4 June 2011

Available Tools

  • Page Layout helps to standardize the look of pages
  • Tool Box shows you wiki markup for the effect you need
  • Typographical_Guidelines standardizes markup for use in translation, either to official manuals (DocBook) or to other languages.

Deciding where to create your page

Many people choose to draft a page on their own Talk page, then move the result to the desired site. Sometimes there is a good reason for preferring to do it in the final location. If that is the case, consider using before your content {{Construction}} which will display

Under Construction

This is a new page, currently under construction!


Wiki Structure

For the convenience of users we try to avoid creating a structure more than three levels deep, avoiding having to type long paths for page names. For most purposes, the following guide will suffice:

Application
Application/Troubleshooting
Application/xxx-How-To
Application/Manual
Application/Manual/Introduction
Application/Manual/Section_1
Application/Manual/Section_xxx

Remember

Please do not use any kind of punctuation in your page names — punctuation like question marks or periods creates serious problems for the wiki software, in particular for the translation system.


Workflow

  1. Navigate to a page, which will contain a link to your new page
  2. Edit this page and insert a link to a new, not yet existing page like this: [[My New Page]]
  3. Write a one-line summary of what you changed
  4. Hit the Preview button and check your work
  5. Save your edits.

Now the page shows a red colored link to your upcoming page. A click on this link will send you directly to your new page and will open the edit box.

Note

A double-Enter is required to make a new paragraph. Please use this after any heading, as it puts headings in a separate translation unit which is preferred by translators using external tools.


Note

If you are making frequent edits to your page, please use either {{Construction}} or {{Being_Edited}} so that translators and other contributors know to wait until you are finished.


Warning

Avoid using text smilies as they cause problems for translation applications (due to unbalanced parentheses). Instead use {{Smiley}} Other smilies can be found on [Commons Wikimedia] and the file-name is sufficient to get the image included


Note

For help about editing existing pages read Modify a Page.