diff --git a/source/components/editing/index.rst b/source/components/editing/index.rst --- a/source/components/editing/index.rst +++ b/source/components/editing/index.rst @@ -17,6 +17,7 @@ radiobutton slider spinbox + sliderspin swipelistitem tableview textedit @@ -52,3 +53,4 @@ * :doc:`date` * :doc:`slider` * :doc:`spinbox` +* :doc:`sliderspin` diff --git a/source/patterns/content/sliderspin.rst b/source/components/editing/sliderspin.rst rename from source/patterns/content/sliderspin.rst rename to source/components/editing/sliderspin.rst diff --git a/source/components/index.rst b/source/components/index.rst --- a/source/components/index.rst +++ b/source/components/index.rst @@ -80,3 +80,4 @@ * :doc:`editing/date` * :doc:`editing/slider` * :doc:`editing/spinbox` +* :doc:`editing/sliderspin` diff --git a/source/patterns/content/breadcrumb.rst b/source/patterns/content/breadcrumb.rst deleted file mode 100644 --- a/source/patterns/content/breadcrumb.rst +++ /dev/null @@ -1,54 +0,0 @@ -Breadcrumbs -=========== - -Purpose -------- - -The *breadcrumbs* pattern is a navigation aid that helps to keep track -of the location within applications or documents by a) providing -information about the current position within the hierarchy, and b) -offering shortcut links to jump to previous positions without using the -Back button (e.g. home > documents > business). The breadcrumb trail -extends the address bar with (clear) access to subsections. It has the -advantage of distinctness in usage. As a drawback the breadcrumbs -usually needs more space. - -Guidelines ----------- - -Is this the right control -~~~~~~~~~~~~~~~~~~~~~~~~~ - -- Use a breadcrumb trail for orientation and navigation in strictly - hierarchical data, :doc:`n-deep content structures `. - Apply other controls like tags for flat or less organized content (e.g. wizards). -- Make sure the breadcrumbs has only supportive functions. Do not use - it as primary and exclusive navigation pattern. -- Do not use a breadcrumbs to just identify or label the position. -- Do not make the breadcrumb navigation dynamic by adopting the last - user's interactions (known as 'path breadcrumbs'). Breadcrumbs should - show the hierarchy, not the user's history. - -Behavior -~~~~~~~~ - -- Link all breadcrumbs steps to the appropriate page or position - respectively, except the current. -- Add the current position to the breadcrumbs. -- Consider to provide a dropdown list for alternative options on each - level. But always offer one-click access by default. -- Consider to make the breadcrumbs interactive via drag and drop, e.g. - copy/move files by dragging them to a breadcrumb step or to an item - of the dropdown list, apply a sequence of processing steps, etc. - -Appearance -~~~~~~~~~~ - -- Keep the breadcrumbs plain; do not use icons or other controls. -- Place the breadcrumbs above the content control (e.g. file list). - -- Do not place it above the navigation control (e.g. directory - structure) -- Do not integrate it into the tool bar -- Do not place it in an extra tool bar. -- Do not integrate it into the title bar. diff --git a/source/patterns/content/index.rst b/source/patterns/content/index.rst --- a/source/patterns/content/index.rst +++ b/source/patterns/content/index.rst @@ -6,20 +6,16 @@ :titlesonly: :hidden: - breadcrumb duallist form iconandtext help settings - sliderspin viewingediting -- :doc:`breadcrumb` - :doc:`duallist` - :doc:`form` - :doc:`iconandtext` - :doc:`help` - :doc:`settings` -- :doc:`sliderspin` - :doc:`viewingediting` diff --git a/source/patterns/navigation/breadcrumb.rst b/source/patterns/navigation/breadcrumb.rst --- a/source/patterns/navigation/breadcrumb.rst +++ b/source/patterns/navigation/breadcrumb.rst @@ -1,5 +1,5 @@ -Breadcrumb patterns -=================== +Breadcrumbs +=========== .. container:: intend @@ -10,9 +10,40 @@ .. image:: /img/NP-n-deep.png :alt: Breadcrumb patterns -- These patterns provide awareness of the path within the content - structure. -- Interaction is usually required to determine location relative to - adjacent content on the previous level. -- The pattern may also be applied to 2-deep and 3-deep content - structures. +The *breadcrumbs* pattern is a navigation aid for hierarchical content +structures (e.g. home > documents > business). It provides information about +the current position within the hierarchy, and offers shortcut links to jump +to previous positions without using the Back button. + +When to use +----------- + +- Use a breadcrumb control for orientation and navigation in strictly + hierarchical content. Apply other controls like tags for flat or less + organized content. +- Make sure a breadcrumb control has only supportive functions. Do not use + it as primary and exclusive navigation pattern. +- Do not use a breadcrumb control to just identify or label the position; + it must be interactive. +- Do not make the breadcrumb control dynamic by showing the user's past + interactions (known as 'path breadcrumbs'). Breadcrumbs should + show the hierarchy, not the user's history. + +How to use +---------- + +- Link all breadcrumb steps to the appropriate page or position. Show the + current position at the very end of the breadcrumb control. +- Keep breadcrumbs plain and textual; do not use icons or other controls. +- Place a breadcrumb control above the content area, but below other + navigation controls. +- Do not integrate a breadcrumb control into a toolbar or titlebar. + +Implementation +-------------- + +- Consider providing a dropdown context menu full of alternative options for + each breadcrumb item. But always offer one-click access by default. +- Think of ways to make the breadcrumb control interactive in other creative + ways. For example, it might permit content to be dragged-and-dropped + onto a breadcrumb item to quickly move it there. diff --git a/source/patterns/navigation/index.rst b/source/patterns/navigation/index.rst --- a/source/patterns/navigation/index.rst +++ b/source/patterns/navigation/index.rst @@ -97,5 +97,5 @@ Examples include file systems and archives. -- :doc:`Breadcrumb ` +- :doc:`Breadcrumbs ` - :doc:`Column-based navigation `