revi-archive/phorge-phorge
1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-11-30 02:32:42 +01:00
Code Issues Releases Wiki Activity

Update Profile Menu diviner

Browse source 
Summary: Ref T12174, Updates documentation to better match current functionality.

Test Plan: I keep getting exceptions trying to generate diviner locally, not sure what's up.

Reviewers: epriestley

Reviewed By: epriestley

Subscribers: Korvin

Maniphest Tasks: T12174

Differential Revision: https://secure.phabricator.com/D17309
This commit is contained in:
Chad Little 2017-02-03 18:23:58 -08:00
parent 281e9849ed
commit c8de563622
1 changed files with 34 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
src/docs/user/userguide/profile_menu.diviner
View file

@ -16,21 +16,12 @@ Supported Applications
These applications currently support profile menus: These applications currently support profile menus:
| Application | Support | | Application | Customization | Support |
|-----|-----| |-----|-----|-----|
| Projects | Full | | Home | Global/Personal | Full |
| People | //Read-Only// | | Projects | Per Project | Full |
| Favorites Menu | Global/Personal | Full |
| People | None | //Read-Only// |
Collapsing and Expanding
========================
To collapse a full-width profile menu, click
{nav icon="angle-left", name="Collapse"}. To expand a narrow menu, click
{nav icon="angle-right", name="Expand"}.
If you're logged in, this setting is sticky, and all menus will respect your
preference.
Editing Menus Editing Menus
@ -40,7 +31,10 @@ You can only edit an object's menu if you can edit the object. For example, you
must have permission to edit a project in order to reconfigure the menu for the must have permission to edit a project in order to reconfigure the menu for the
project. project.
To edit a menu, click {nav icon="cogs", name="Manage"} in the menu, then click To edit a menu, click {nav icon="cogs", name="Manage"} or {nav icon="pencil",
name="Edit ..."} in the menu itself. If you are an administrator and the
application supports Global/Personal customization, you'll have the option
of editing either the Global settings or your own Personal menu, otherwise click
{nav icon="th-list", name="Edit Menu"}. This brings you to the menu {nav icon="th-list", name="Edit Menu"}. This brings you to the menu
configuration interface which allows you to add and remove items, reorder the configuration interface which allows you to add and remove items, reorder the
menu, edit existing items, and choose a default item. menu, edit existing items, and choose a default item.
@ -94,7 +88,7 @@ To remove items, click the {nav icon="times", name="Delete"} action.
Builtin items can not be deleted and have a Builtin items can not be deleted and have a
{nav icon="times", name="Disable"} action instead, which will hide them but {nav icon="times", name="Disable"} action instead, which will hide them but
not delete them. You an re-enable a disabled item with the not delete them. You an re-enable a disabled item with the
{nav icon="plus', name="Enable"} action. {nav icon="plus", name="Enable"} action.
A few items can not be hidden or deleted. For example, the A few items can not be hidden or deleted. For example, the
{nav icon="cogs", name="Manage"} item must always be available in the menu {nav icon="cogs", name="Manage"} item must always be available in the menu
@ -130,17 +124,36 @@ When you add items, you can choose between different types of items to add.
Which item types are available depends on what sort of object you are editing Which item types are available depends on what sort of object you are editing
the menu for, but most objects support these items: the menu for, but most objects support these items:
- {icon link} **Link**: Allows you to create an item which links to
somewhere else in Phabricator, or to an external site.
- {icon minus} **Divider**: Adds a visual separator to the menu. This is - {icon minus} **Divider**: Adds a visual separator to the menu. This is
purely cosmetic. purely cosmetic.
- {icon coffee} **Motivator**: Motivate your employees with inspirational - {icon map-marker} **Label**: Lets you label sections of menu items.
quotes. A new quote every day! This is also purely cosmetic.
- {icon link} **Link**: Allows you to create an item which links to
somewhere else in Phabricator, or to an external site.
- {icon plus} **Form**: Provides quick access to custom and built-in forms
from any application that supports EditEngine.
- {icon briefcase} **Projects**: Provides quick access to a project.
- {icon globe} **Applications**: Provides quick access to your favorite
applications. Can be renamed.
- {icon tachometer} **Dashboard**: Provides quick access to your favorite
dashboard. These items will display with the current nav on the item
you've attached it to.
To learn more about how an item works, try adding it. You can always delete To learn more about how an item works, try adding it. You can always delete
it later if it doesn't do what you wanted. it later if it doesn't do what you wanted.
Dashboard Integration
=====================
Dashboards are directly integrated with Profile Menus. If you add a Dashboard
to a Project or to a Home menu, that Dashboard will be presented in the
context of that menu. This allows customization of different pages of content
without having the user leave Home or the Project.
Writing New Item Types Writing New Item Types
====================== ======================