Wiki Style Guide (1 Viewer)

CyberSimian

Test Group
  • Team MediaPortal
  • June 10, 2013
    1,983
    1,234
    Southampton
    United Kingdom United Kingdom
    Country flag
    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
     

    high

    Administrator
  • Team MediaPortal
  • August 31, 2004
    4,927
    5,062
    Isselburg/NRW
    Germany Germany
    Country flag
    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)
     

    CyberSimian

    Test Group
  • Team MediaPortal
  • June 10, 2013
    1,983
    1,234
    Southampton
    United Kingdom United Kingdom
    Country flag
    I would suggest to consult the old guide to get some ideas,
    Thanks; I have read the guidelines and think that I have adhered to the style (mostly :unsure:).

    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).
    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
     

    Users Who Are Viewing This Thread (Users: 0, Guests: 1)

    OP Similar threads Forum Replies Date
    CyberSimian Nested bullet lists in the Wiki Website/Forum/Wiki Feedback 2
    O Can't access the Wiki Online Facilities 5
    HTPCSourcer [solved] Can't log in to Wiki Online Facilities 3
    N [Proposal] Make text input possible with remote control in SMS style MediaPortal 2 1
    D Display Day of week in TV Guide? Feature Requests 0
    S Shortcuts MP1 My Recorded & TV Guide General 10
    framug Nouveau plugin XmlTvFR pour récupérer le guide télé français Kazer / ZguideTv (WebEPGfr) 11
    G Movie release date in guide Electronic Program Guide 2
    M [Rejected] Always show full hours in TV Guide Feature Requests 2
    M [fixed] [MP2-831] 12h time format shown in TV Guide with Swedish language settings Submit: Bug Reports 27
    geotwticher TV Guide EPG Grabber for Australia 2020 RIP freepg.tv General 4
    B [solved] MP2.2.3 TV Guide not scrolling with mouse wheel General 2
    R [solved] All Channel 7 stations listed in guide as 1000 Newcomers Forum 4
    T Freeview EPG-Anyone know what channel sends the guide data? Electronic Program Guide 10
    M Guide mapping schedules direct, tvguide, epg buddy How to get correct entry to the correct channel? Electronic Program Guide 0
    G Newb trying MP2, trouble with guide data General 5
    C How do I see the broadcast channel decimal numbers in the guide? General 0
    M [Pending] Fix for Inconsistent date display in TV Guide Submit: code patches (MediaPortal/TV-Server/etc.) 1
    G [solved] Are genres in the guide working properly General 4
    drumrob Inconsistent date display in TV Guide 1.22 Pre Release 15
    HTPCSourcer [Evaluate] MP2-Updates do not remove the GUID of previous installs MediaPortal 2 13
    Rob Hexenmeister Radio Guide descriptions in myradio.xml (screen 30) MediaPortal 1 Skins 3
    N Include both TV and Radio channels together in the guide Feature Requests 2
    doskabouter No guide info added due to a MYSQL deadlock Electronic Program Guide 1
    Patrik-See [solved] MediaPortal 2.2 Fernseher bleibt schwarz nach TV Sender Stop Allgemeines Support- und Diskussionsforum 2
    Similar threads

























    Top Bottom