PageLayout: Difference between revisions

    From KDE UserBase Wiki
    (Moved notes to Create and Modify page instructions)
    (Marked this version for translation)
    (11 intermediate revisions by 6 users not shown)
    Line 2: Line 2:
    You should aim to get as many of the sections into your page as is practicable.  
    You should aim to get as many of the sections into your page as is practicable.  


    ==Available Tools==
    <languages />
    <translate>


    * [[Toolbox|Tool Box]] shows you wiki markup for the effect you need
    ==Available Tools== <!--T:1-->
    * [[Typographical Guidelines]] standardises markup for use in translation, either to official manuals (DocBook) or to other languages.


    ==Sections==
    <!--T:2-->
    * [[Special:myLanguage/Toolbox|Tool Box]] shows you wiki markup for the effect you need
    * [[Special:myLanguage/Typographical Guidelines|Typographical Guidelines]] standardises markup for use in translation, either to official manuals (DocBook) or to other languages.


    ==Sections== <!--T:3-->
    <!--T:4-->
    {|
    {|
    ! Section  
    ! Section  
    ! Description
    ! Description
    ! Relevance
    ! Relevance
    |-
    |-<!--}-->
     
    <!--T:5-->
    ! Language selector
    ! Language selector
    | The i18n language bar previously used does not work with TranslateWiki. Please do not use it. A new language bar will be created by the first translation being prepared.
    | The i18n language bar previously used does not work with TranslateWiki. Please do not use it. A new language bar will be created by the first translation being prepared.
    | deprecated
    | deprecated
    |-
    |-
    <!--T:6-->
    ! Image header
    ! Image header
    | A two-cell table containing a header, laid out with {{Input|1=<nowiki>{|class="tablecenter vertical-centered"  
    | A two-cell table containing a header, laid out with {{Input|1=<nowiki>{|class="tablecenter vertical-centered"  
    Line 25: Line 34:
    | important
    | important
    |-
    |-
    <!--T:16-->
    ! History
    | A brief history of the application including for example the first release date and others major events. It's recommended to add references.
    | optional
    |-
    <!--T:7-->
    ! Features
    ! Features
    | A brief feature list, under a heading, and consisting of bullet points.  These are indented by default - no need to specify indentation.  
    | A brief feature list, under a heading, and consisting of bullet points.  These are indented by default - no need to specify indentation.  
    | important
    | important
    |-
    |-
    <!--T:8-->
    ! Details
    ! Details
    | One or more heading giving more in-depth information about using the application  
    | One or more heading giving more in-depth information about using the application  
    | optional
    | optional
    |-
    |-
    <!--T:9-->
    ! Screenshots
    ! Screenshots
    | Screenshots to illustrate the above, whenever feasible. These will usually be thumbnails, clickable for enlargement. The size will usually be in the range of 300px to 500px.
    | Screenshots to illustrate the above, whenever feasible. These will usually be thumbnails, clickable for enlargement. The size will usually be in the range of 300px to 500px.
    | important
    | important
    |-
    |-
    <!--T:10-->
    ! Hints and Tips
    ! Hints and Tips
    | Short tips to increase productivity  
    | Short tips to increase productivity  
    | optional
    | optional
    |-
    |-
    <!--T:11-->
    ! Troubleshooting
    ! Troubleshooting
    | List them here or in a subpage
    | List them here or in a subpage
    | optional
    | optional
    |-
    |-
    ! Weblinks
     
    <!--T:12-->
    ! More Information
    | Links to  
    | Links to  
    * an external project site
    * an external project site
    Line 52: Line 79:
    | important<br />if existing
    | important<br />if existing
    |-
    |-
    <!--T:13-->
    ! Category
    ! Category
    | The category will normally be the name of the applications list that points to your page, e.g. applications listed under [[Applications/Office]] would show the statement <nowiki>[[Category:Office]]</nowiki>.
    | The category will normally be the name of the applications list that points to your page, e.g. applications listed under [[Applications/Office]] would show the statement <nowiki>[[Category:Office]]</nowiki>.
    | important
    | important
    |}
    |<!--{-->}


    Please make regular checks of the pages relevant to your work (linked from [[Tasks and Tools|Tasks and Tools]] and also [[Typographical Guidelines|Typographical Guidelines]] as these are updated whenever new issues are noted.
    <!--T:14-->
    Please make regular checks of the pages relevant to your work (linked from [[Special:myLanguage/Tasks and Tools|Tasks and Tools]]) and also [[Special:myLanguage/Typographical Guidelines|Typographical Guidelines]] as these are updated whenever new issues are noted.


    <!--T:15-->
    [[Category:Contributing]]
    [[Category:Contributing]]
    </translate>

    Revision as of 09:07, 17 April 2019

    This page lays out the sections that we would like to see in an ideal page. You should aim to get as many of the sections into your page as is practicable.

    Available Tools

    • Tool Box shows you wiki markup for the effect you need
    • Typographical Guidelines standardises markup for use in translation, either to official manuals (DocBook) or to other languages.

    Sections

    Section Description Relevance
    Language selector The i18n language bar previously used does not work with TranslateWiki. Please do not use it. A new language bar will be created by the first translation being prepared. deprecated
    Image header A two-cell table containing a header, laid out with
    {|class="tablecenter vertical-centered" 
    |[[Image:Image.png|300px]] 
    |Short description
    |}
    important
    History A brief history of the application including for example the first release date and others major events. It's recommended to add references. optional
    Features A brief feature list, under a heading, and consisting of bullet points. These are indented by default - no need to specify indentation. important
    Details One or more heading giving more in-depth information about using the application optional
    Screenshots Screenshots to illustrate the above, whenever feasible. These will usually be thumbnails, clickable for enlargement. The size will usually be in the range of 300px to 500px. important
    Hints and Tips Short tips to increase productivity optional
    Troubleshooting List them here or in a subpage optional
    More Information Links to
    • an external project site
    • the application manual on docs.kde.org
    • other useful internal or external pages
    important
    if existing
    Category The category will normally be the name of the applications list that points to your page, e.g. applications listed under Applications/Office would show the statement [[Category:Office]]. important

    Please make regular checks of the pages relevant to your work (linked from Tasks and Tools) and also Typographical Guidelines as these are updated whenever new issues are noted.