Edgewall Software

Changes between Version 17 and Version 18 of TracProject/UiGuidelines


Ignore:
Timestamp:
Dec 15, 2015, 9:43:00 PM (6 years ago)
Author:
figaro
Comment:

Added image, preparing for inclusion elsewhere

Legend:

Unmodified
Added
Removed
Modified
  • TracProject/UiGuidelines

    v17 v18  
     1[[PageOutline(2-5,Contents,pullout)]]
     2
    13= Trac User Interface Guidelines
    24
    35== Navigation
    46
    5 ''These aren't real guidelines yet, but they could eventually emerge from this document. This document is an analysis and a proposal initially written by ChristopherLenz, and is open to comments and suggestions from the community.''
     7''These guidelines aren't official. This document is an analysis and a proposal initially written by ChristopherLenz, and is open to comments and suggestions from the community.''
    68
    79=== Current Situation
     
    2224 1. '''Footer links''': Links to Edgewall and Trac.
    2325
    24 Of this list, items 1, 2, 3, 4 and 9 can together be referred to as the ''Global Navigation''. The global navigation obviously should never change between different modules. Technically, it is generated by the templates [source:tags/trac-0.10/templates/header.cs header.cs] and [source:tags/trac-0.10/templates/footer.cs footer.cs], which are included at the top and bottom of every module template, respectively.
     26[[Image(Trac_navigational_elements.png)]]
    2527
    26 The module- and/or page-specific navigation elements (5. and 6.) can together be referred to as "Context Navigation". However, they are currently not clearly defined and their use is not consistent throughout the different modules. Let's look at a couple of examples:
     28Of this list, items 1, 2, 3, 4 and 9 can together be referred to as the '''Global Navigation'''. The global navigation obviously should never change between different modules. Technically, it is generated by the templates [source:tags/trac-0.10/templates/header.cs header.cs] and [source:tags/trac-0.10/templates/footer.cs footer.cs], which are included at the top and bottom of every module template, respectively.
     29
     30The module- and/or page-specific navigation elements (5. and 6.) can together be referred to as '''Context Navigation'''. However, they are currently not clearly defined and their use is not consistent throughout the different modules. Let's look at a couple of examples:
    2731
    2832  '''Wiki''':
     
    4044  When viewing the list of available reports, two module navigation links are available: ''Available Reports'' and ''Custom Query''. Both remain available when opening a specific report. However, when viewing the report list or the custom query, only the ''alternative'' view remains selectable.
    4145
    42   There used to be ''action-type links'' in the report module. AFAICT, there's no such links anymore, everything that triggers an ''action'' in Trac is presented as a button in the interface.
    43 
    4446==== Conclusion
    4547
     
    4850=== Possible Solutions
    4951
    50 It is obvious (I hope) that there is a need to fix the inconsistencies in the navigation. Apart from layout details (such as the different look of local navigation links in the browser than in the reports module), there are a basically two drastically different options:
     52For usability purposes there is a need to fix these inconsistencies in the navigation. Apart from layout details, such as the different look of local navigation links in the browser than in the reports module, there are a basically two drastically different options:
    5153
    5254 1. '''Draw a strong line between module-level and page-level navigation links'''. Develop a layout that helps the user understand the conceptual difference, so that she can learn to automatically look at the right place when searching for a specific link.
    53  1. '''Merge module-level and page-level navigation''', as the conceptual difference may not be clear to the occassional user. More places to look at searching for navigational elements means more confusion/frustration with using Trac.
     55 1. '''Merge module-level and page-level navigation''', as the conceptual difference may not be clear to the occasional user. More places to look at searching for navigational elements means more confusion and frustration with using Trac.
    5456
    5557I'm tending towards the first approach, because the recent emergence of visually distinct local navigation elements probably did happen for a reason. In addition, I'd like to see us merging the action triggers with the local navigation, as well as moving all alternate format links into the corresponding navigation element.
     
    8688 * '''Page Mode Options''', for actions that depend on the current page '''mode''', such as ''View'', ''Modify'', ... these actions are acting on this same page, and therefore should appear as appropriate. All actions should also be rendered as buttons (as active or disabled), as this implies more clearly their nature (''that latter point is "fixed" now'' -- cboos). Also, you may want in some cases to be able to display these multiple times on the same page, for convenience... such as the "Save Changes", "Cancel" options when editing a wiki page could be in 2 places, below the main textarea as well as below the previewed content (''this is the case for e.g. ''View Differences...'' buttons'' -- cboos).  --mario
    8789
    88 To follow-up on the '''Page Mode Options''' idea, I think that there should be an easy way to switch between different "aspects" of the same resource, maybe using "tabs" a la WikiPedia.
     90To follow-up on the '''Page Mode Options''' idea, I think that there should be an easy way to switch between different "aspects" of the same resource, maybe using "tabs" a la Wikipedia.
    8991
    9092 - For Wiki pages, in addition to the default ''article'', there could be an ''History'' mode and
    9193   a ''Discussion'' page (comments for wiki pages, similar to the ones we currently have for tickets).
    92    Improving upon WikiPedia, the ''article'' tab could even show the actual WikiPageName, which would
     94   Improving upon Wikipedia, the ''article'' tab could even show the actual WikiPageName, which would
    9395   answer to the feature request expressed [#wiki-page-title above].
    9496 - For Ticket pages, we could as well have a ''View'', ''History'' and eventually a ''SubTickets'' page.