Wiki Style Guide

Discussion in 'Website/Forum/Wiki Feedback' started by CyberSimian, January 25, 2017.

  1. CyberSimian
    • Team MediaPortal

    CyberSimian Test Group

    Joined:
    June 10, 2013
    Messages:
    1,645
    Likes Received:
    542
    Gender:
    Male
    Location:
    Southampton
    Ratings:
    +962 / 3
    Home Country:
    United Kingdom United Kingdom
    Show System Specs
    Is there a Wiki Style Guide? I searched for one but did not find anything useful. In the "Getting Started" section on the following page:



    MediaPortal Wiki - Getting Started - MediaPortal Wiki

    there is a clickable link called "contribution guide", but it links to itself. :eek:

    My specific question relates to the use of heading levels. I have just been updating the page called "Colors" in the "Skin Architecture" section. The page begins with an H1 for "Colors", which is followed by more H1 headings. That does not seem right. The "Colors" heading is like a chapter heading, so H1 is appropriate. But I would expect subsequent headings on the same page to be H2, or H3, or H4, ... (as appropriate). There is one H2 heading ("Examples"), but for consistency either that should be H1, or the other H1 tags should be H2 (apart from "Colors"). What is the MP Wiki convention for the use of heading levels? Thank you.

    -- from CyberSimian in the UK
     
  2. Google AdSense Guest Advertisement



    to hide all adverts.
  3. high
    • Team MediaPortal
    • IT-Admin

    high Administrator

    Joined:
    August 31, 2004
    Messages:
    4,742
    Likes Received:
    3,114
    Gender:
    Male
    Occupation:
    Sysadmin
    Location:
    Isselburg/NRW
    Ratings:
    +4,827 / 6
    Home Country:
    Germany Germany
    Show System Specs
    There's no updated guide for Confluence yet. I would suggest to consult the old guide to get some ideas, even if several pages are outdated because they refer to Mindtouch wiki: Contribute to Wiki - MediaPortal Wiki

    For this specific page I would recommend to leave Overview as H1 and change the following 3 to H2 (Example is not a subelement of previous h2 so a h3 would not fit here). First h1 is just the page-tile and not shown in "Table of Contents" (if used on a page)
     
    • Thank You! Thank You! x 1
  4. CyberSimian
    • Team MediaPortal

    CyberSimian Test Group

    Joined:
    June 10, 2013
    Messages:
    1,645
    Likes Received:
    542
    Gender:
    Male
    Location:
    Southampton
    Ratings:
    +962 / 3
    Home Country:
    United Kingdom United Kingdom
    Show System Specs
    Thanks; I have read the guidelines and think that I have adhered to the style (mostly :unsure:).

    I have had a look at some other pages in the "Skin Architecture" section, and the style seems to be to use H1 tags within the page (contrary to my expectation). So I have done the following:

    (1) On the "Colors" page, the sections after "Overview" are not really sub-sections of "Overview", so I have left them as H1.

    (2) I agree with your point about the "Examples" section, so I have changed that from H2 to H1.

    (3) I decided to separate some text into a sub-section of its own, and have introduced an H2 for that.

    I hope that you are happy with this? Once I am familiar with MP conventions, there won't be so many questions! :D

    -- from CyberSimian in the UK
     
    • Like Like x 2
  5. high
    • Team MediaPortal
    • IT-Admin

    high Administrator

    Joined:
    August 31, 2004
    Messages:
    4,742
    Likes Received:
    3,114
    Gender:
    Male
    Occupation:
    Sysadmin
    Location:
    Isselburg/NRW
    Ratings:
    +4,827 / 6
    Home Country:
    Germany Germany
    Show System Specs
    hey, I'm happy with every single edit/update ;) The guidelines are just a rough idea and some years old. As long as the result work as a page anyone is free to add his own style/preferences to "his" content.
     
    • Thank You! Thank You! x 1
Loading...

Users Viewing Thread (Users: 0, Guests: 0)

  1. This site uses cookies to help personalise content, tailor your experience and to keep you logged in if you register.
    By continuing to use this site, you are consenting to our use of cookies.
    Dismiss Notice
  • About The Project

    The vision of the MediaPortal project is to create a free open source media centre application, which supports all advanced media centre functions, and is accessible to all Windows users.

    In reaching this goal we are working every day to make sure our software is one of the best.

             

  • Support MediaPortal!

    The team works very hard to make sure the community is running the best HTPC-software. We give away MediaPortal for free but hosting and software is not for us.

    Care to support our work with a few bucks? We'd really appreciate it!