Changes between Version 1 and Version 2 of TracNavigation


Ignore:
Timestamp:
Sep 2, 2019, 4:56:56 PM (5 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracNavigation

    v1 v2  
    1 = ナビゲーション = #TracNavigation
     1= Trac Navigation
    22
    3 Trac 0.11 以降では、メインナビゲーションとメタナビゲーションのエントリを簡単な方法でカスタマイズできるようになりました。
     3The main and meta navigation entries can be customized in several ways. The `[mainnav]` and `[metanav]` configuration sections can be used to customize the navigation item text and link, change the ordering of the navigation items, disable them and add new ones.
    44
    5 新しく追加されたコンフィグのセクション `[mainnav]` と `[metanav]` を使用すると、ナビゲーション項目に使用されるテキストとリンクをカスタマイズしたり、無効化することができます。コンフィグのセクション `[trac]` に `mainnav` と `metanav` をオプションとして使用すると、並び順を変更することができます。
     5The primary attributes that can be customized are `href`, `label`, `order` and `permission`.
    66
    77=== `[mainnav]` #mainnav-bar
    8 `[mainnav]` は '''メインナビゲーションバー (main navigation bar)''' に対応しています。メインナビゲーションは ''Wiki'', ''タイムライン'' (英語版では ''Timeline''), ''ロードマップ'' (英語版では ''Roadmap''), ''リポジトリブラウザ'' (英語版では ''Browse Source'') のようなエントリを含むバーです。このナビゲーションバーは 現在のユーザがアクセス可能な Trac で有効な各メインモジュールのデフォルトページにアクセスします。
     8`[mainnav]` corresponds to the '''main navigation bar''', the one containing entries such as ''Wiki'', ''Timeline'', ''Roadmap'', ''Browse Source'' and so on. This navigation bar is meant to access the default page of the main modules enabled in Trac that are accessible for the current user.
    99
    1010
    11 ** [=#Example 例] **
     11** [=#Example Example] **
    1212
    13 以下の例では、 Wiki のスタートページへのリンク名を "Home" に変更して、"チケットを見る" (英語版では "View Tickets") エントリを特定のレポートにリンクさせます。2 つめの例では、"ヘルプ/ガイド" (英語版では "!Help/Guide") を非表示にします。
    14 
    15 TracIni からの引用:
    16 {{{
     13In the following example we rename the link to WikiStart //Home//, and make the //View Tickets// entry link to a specific report.
     14{{{#!ini
    1715[mainnav]
    1816wiki.label = Home
    … …  
    2018}}}
    2119
     20Note the entries on the main navigation are displayed in uppercase regardless of the casing of the `label`, unless this aspect of the styling is overridden through [TracInterfaceCustomization#SiteAppearance interface customization].
     21
    2222=== `[metanav]` #metanav-bar
    23 `[metanav]` は '''メタナビゲーションバー (meta navigation bar)''' に対応しています。メタナビゲーションは通常、メインナビゲーションバーの上、 ''検索'' (英語版では ''Search'') ボックスの下に配置されています。 ''ログイン'' (英語版では ''Log in''), ''ログアウト'' (英語版では ''Logout''), ''ヘルプ/ガイド'' (英語版では ''!Help/Guide'') などのエントリが含まれています。このナビゲーションバーは Trac プロジェクト全体の情報や、現在のユーザの情報にアクセスします。
     23`[metanav]` corresponds to the '''meta navigation bar''', by default positioned above the main navigation bar and below the ''Search'' box. It contains the ''Login'', ''Logout'', ''!Help/Guide'' etc. entries. This navigation bar is meant to access some global information about the Trac project and the current user.
    2424
    25 `[metanav]` セクションには特別なエントリを記述できます: `logout.redirect` を設定することで、ログアウト後に表示するページを指定できます。
    26 [[comment([trac:#3808 #Trac3808] を参照してください)]]
     25There is one special entry in the  `[metanav]` section: `logout.redirect` is the page the user sees after hitting the logout button.  The ''!Help/Guide'' link is also hidden in the following example.
     26[[comment(see also #Trac3808)]]
    2727
    28 ** 例 **
     28** Example **
    2929
    30 {{{
     30{{{#!ini
    3131[metanav]
    3232help = disabled
    … …  
    3434}}}
    3535
     36=== Extra Navigation Entries #nav-extra-entries
    3637
    37 === Notes === #Notes
    38 記述可能な URL のフォーマット (for `.href` or `.redirect`):
    39 || '''設定内容''' || '''リダイレクト先''' ||
     38New navigation entries can be arbitrarily defined and added
     39to the navigation. A new entry can be defined by providing a name with value `enabled`. At a minimum, the `href` attribute should be specified to define a useful navigation entry. If the `label` attribute is not defined the entry's name will be used for the label.
     40
     41The following example creates two new navigation items, one named //My Reports// and the other named //builds//. //My Reports// is only visible to users with `REPORT_VIEW` permission.
     42{{{#!ini
     43[mainnav]
     44myreports = enabled
     45myreports.href = /report/9
     46myreports.label = My Reports
     47myreports.permission = REPORT_VIEW
     48
     49[metanav]
     50builds = enabled
     51builds.href = https://travis-ci.org/edgewall/trac
     52}}}
     53
     54The entry names are always read as lowercase, as is the case for all keys in the trac.ini file due to the way the configuration parser is configured. If the example above used `BUILDS` rather than `builds` for the name, the entry would still be displayed as `builds`. Use the `label` attribute for case-sensitive customization of the navigation entry text.
     55
     56=== Relocating Entries #nav-relocating-entries
     57
     58Navigation entries provided by Trac and plugins can be moved from the meta navigation bar to the main navigation bar, and vise-versa. The entry should be defined in the desired category as if it was a new entry. For example, to move the //Admin// entry to the metanav and rename it to //Administration//:
     59{{{#!ini
     60[metanav]
     61admin = enabled
     62admin.label = Administration
     63}}}
     64
     65Attributes of the navigation item that are not overridden by the configuration will be preserved.
     66
     67=== URL Formats
     68Possible URL formats for `.href` or `.redirect`:
     69|| '''config''' || '''redirect to''' ||
    4070|| `wiki/Logout` || `/projects/env/wiki/Logout` ||
    4171|| `http://hostname/` || `http://hostname/` ||
    … …  
    4373
    4474
    45 === `[trac]` #nav-order
    46 コンフィグのセクション `[trac]` に `mainnav` と `metanav` をオプションとして使用すると、ナビゲーション項目の表示順を変更することができます。プラグインをインストールしナビゲーション項目が追加されても有効です。
     75=== Ordering #nav-order
     76The `order` attribute specifies the order in which the navigation items are displayed. This can be particularly useful for plugins that add navigation items.
    4777
    48 ** 例 **
     78Non-negative floating point values may be used for the `order` attribute. The navigation items will be arranged from left to right in increasing order. Navigation items without an `order` attribute are sorted alphabetically by name.
    4979
    50 以下の例では、チケットに関連する項目を優先し、左側に移動させています。
     80The default values are:
     81{{{#!ini
     82[mainnav]
     83browser.order = 4
     84newticket.order = 6
     85roadmap.order = 3
     86search.order = 7
     87tickets.order = 5
     88timeline.order = 2
     89wiki.order = 1
    5190
    52 TracIni からの引用:
    53 {{{
    54 [trac]
    55 mainnav = wiki,tickets,newticket,timeline,roadmap,browser,search,admin
     91[metanav]
     92about.order = 5
     93help.order = 4
     94login.order = 1
     95logout.order = 2
     96prefs.order = 3
    5697}}}
    5798
    58 並び順と項目名の初期値はソースの中に記されています。その記述は [source:trunk/trac/web/chrome.py@10883:397,402-403#L396 ここ] です。
     99=== Permissions #nav-permissions
     100The `permission` attribute controls the visibility of the navigation item on the navigation bar. This is mainly useful for new entries in the navigation bar. Note that it does not provide access control to the URL that the navigation item directs to, and cannot override permission checks done by Trac and plugins.
    59101
    60 === コンテキストナビゲーション === #ctxtnav-bar
     102For example, the //Roadmap// navigation item will only display for users with `ROADMAP_VIEW`. Adding the attribute `roadmap.permission = MILESTONE_VIEW` will require both `ROADMAP_VIEW` and `MILESTONE_VIEW` for the entry to be visible, but as noted will not provide access control for the `/roadmap` path. TracFineGrainedPermissions should be used for access control to modules provided by Trac and plugins.
    61103
    62 今のところ、 '''コンテキストナビゲーションバー (contextual navigation bar)''' をカスタマイズすることはできません。コンテキストナビゲーションはメインナビゲーションの下に位置するバーです。
     104=== Context Navigation #ctxtnav-bar
    63105
     106Note that it is still not possible to customize the '''contextual navigation bar''', i.e. the one usually placed below the main navigation bar.
    64107
    65108----
    66 See also: TracInterfaceCustomization, [http://trac-hacks.org/wiki/NavAddPlugin TracHacks:NavAddPlugin] または [http://trac-hacks.org/wiki/MenusPlugin TracHacks:MenusPlugin] (エントリを追加する際に必要になります)
     109See also: TracInterfaceCustomization