Writing an Application Manual/uk: Difference between revisions

    From KDE UserBase Wiki
    (Created page with "==Зміст==")
    (Created page with "* Коли всі рішення буде прийнято (процес складання плану може бути доволі тривалим), створіть відп...")
    Line 23: Line 23:
    ==Зміст==
    ==Зміст==


    * Once you have made the decisions (that can be a lengthy procedure), create appropriate links on the Contents page.   It is, of course, possible to insert a section later if you find you've missed something.
    * Коли всі рішення буде прийнято (процес складання плану може бути доволі тривалим), створіть відповідні посилання на сторінці змісту. Звичайно ж, якщо ви щось пропустили, пізніше можна буде додати відповідне посилання.


    ==Building your Manual==
    ==Building your Manual==

    Revision as of 13:09, 6 June 2011

    Other languages:

    Нотатки

    Підручники буде включено як підлеглі сторінки до основної сторінки програми. Нехай, основна сторінка програми має назву Appname. Тоді структура сторінок має бути десь такою:

    • Appname
      • Appname/Hints and Tips
    • Appname/Manual # Сторінка змісту
      • Appname/Manual/An Introduction to Appname
      • Appname/Manual/Configuration Choices
      • Appname/Manual/The First Time you use Appname
      • Appname/Manual/section 1
      • Appname/Manual/section xxx
      • Appname/Manual/Hints and Tips
      • Appname/Manual/Troubleshooting
      • Appname/Manual/Found a bug?
      • Appname/Manual/Get involved # посилання на сторінку techbase тощо

    Пам’ятайте!

    Будь ласка, не використовуйте знаки пунктуації у назвах сторінок — знаки пунктуації, зокрема знаки запитання або крапки, є доволі серйозною проблемою для програмного забезпечення вікі, зокрема системи перекладу.


    Вам знадобиться якась чернетка для експериментів з заголовками розділів та сторінками підручника. Ви можете скористатися або власною сторінкою обговорення, або сторінками з ділянки, над якою ви працюєте. Після завершення роботи варто вилучити всі зайві сторінки.

    Зміст

    • Коли всі рішення буде прийнято (процес складання плану може бути доволі тривалим), створіть відповідні посилання на сторінці змісту. Звичайно ж, якщо ви щось пропустили, пізніше можна буде додати відповідне посилання.

    Building your Manual

    • Use the red links to create the page, and write up a section at a time.
    • Note on the Discussion page anything you will need to refer to later, such as links that can't yet be created.

    Remember

    It's important to be consistent, particularly in Manuals, so here are some general rules:
    • Take care with heading levels - we start at second level (Mediawiki uses top level for page-name), using ==
    • Make application name formatting consistent (avoid using Amaroks, do use Amarok's).
    • Ensure that all images are in PNG format (you can use JPEG (.jpeg, not .jpg) as well, but in this case you should convert your images to PNG later. Save work by converting them before you start .
    • Remove all non-printable characters from image names.


    Preparing the Manual for Translation