Changes between Version 2 and Version 3 of TracNavigation

Timestamp:

Sep 19, 2015, 4:39:59 PM (9 years ago)

Author:

trac

Comment:

--

TracNavigation

@@ -1 @@
-= ナビゲーション = #TracNavigation
+= Trac Navigation =
 
-Trac 0.11 以降では、メインナビゲーションとメタナビゲーションのエントリを簡単な方法でカスタマイズできるようになりました。
+Starting with Trac 0.11, it is now possible to customize the main and meta navigation entries in some basic ways.
 
-新しく追加されたコンフィグのセクション `[mainnav]` と `[metanav]` を使用すると、ナビゲーション項目に使用されるテキストとリンクをカスタマイズしたり、無効化することができます。
+The new `[mainnav]` and `[metanav]` configuration sections can now be used to customize the text and link used for the navigation items, or even to disable them.  The `mainnav` and `metanav` options in the `[trac]` configuration section can also be used to change the order.
 
-`[mainnav]` は '''メインナビゲーションバー (main navigation bar)''' に対応しています。メインナビゲーションは ''Wiki'', ''タイムライン'' (英語版では ''Timeline''), ''ロードマップ'' (英語版では ''Roadmap''), ''リポジトリブラウザ'' (英語版では ''Browse Source'') のようなエントリを含むバーです。このナビゲーションバーは Trac で有効に設定され、現在のユーザがアクセスできるようになっている、各メインモジュールのデフォルトページにアクセスします。
+=== `[mainnav]` #mainnav-bar
+`[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.
 
-`[metanav]` は '''メタナビゲーションバー (meta navigation bar)''' に対応しています。メタナビゲーションは通常、メインナビゲーションバーの上、 ''検索'' (英語版では ''Search'') ボックスの下に配置されています。 ''ログイン'' (英語版では ''Log in''), ''ログアウト'' (英語版では ''Logout''), ''ヘルプ/ガイド'' (英語版では ''!Help/Guide'') などのエントリが含まれています。このナビゲーションバーは Trac プロジェクト全体の情報や、現在のユーザの情報にアクセスします。
 
-`[metanav]` セクションには特別なエントリを記述できます: `logout.redirect` を設定することで、ログアウト後に表示するページを指定できます。
+** [=#Example Example] ** 
 
-記述可能な URL のフォーマット:
-|| '''設定内容''' || '''リダイレクト先''' ||
-|| `wiki/Logout` || `/projects/env/wiki/Logout` ||
-|| `http://hostname/` || `http://hostname/` ||
-|| `/projects` || `/projects` ||
-[[comment([http://trac.edgewall.org/ticket/3808 #Trac3808] を参照してください)]]
+In the following example, we rename the link to the Wiki start "Home", and make the "View Tickets" entry link to a specific report.  The second example (below) also hides the "!Help/Guide" link.
 
-今のところ、 '''コンテキストナビゲーションバー (contextual navigation bar)''' をカスタマイズすることはできません。コンテキストナビゲーションはメインナビゲーションの下に位置するバーです。
-
-=== 例 === #Example
-
-以下の例では、 Wiki のスタートページへのリンク名を "Home" に変更して、 "ヘルプ/ガイド" (英語版では "!Help/Guide") を非表示にします。
-さらに、 "チケットを見る" (英語版では "View Tickets") エントリを特定のレポートにリンクさせます。
-
-TracIni からの引用:
+Relevant excerpt from the TracIni:
 {{{
 [mainnav]
 wiki.label = Home
 tickets.href = /report/24
+}}}
 
+=== `[metanav]` #metanav-bar
+`[metanav]` corresponds to the '''meta navigation bar''', by default positioned above the main navigation bar and below the ''Search'' box. It contains the ''Log in'', ''Logout'', ''!Help/Guide'' etc. entries. This navigation bar is meant to access some global information about the Trac project and the current user.
+
+There is one special entry in the  `[metanav]` section: `logout.redirect` is the page the user sees after hitting the logout button. 
+[[comment(see also #Trac3808)]]
+
+** Example ** 
+
+{{{
 [metanav]
 help = disabled
@@ -36 +34 @@
 }}}
 
+
+=== Notes
+Possible URL formats (for `.href` or `.redirect`):
+|| '''config''' || '''redirect to''' ||
+|| `wiki/Logout` || `/projects/env/wiki/Logout` ||
+|| `http://hostname/` || `http://hostname/` ||
+|| `/projects` || `/projects` ||
+
+
+=== `[trac]` #nav-order
+The `mainnav` and `metanav` options in the `[trac]` configuration section control the order in which the navigation items are displayed (left to right).  This can be useful with plugins that add navigation items.
+
+** Example ** 
+
+In the following example, we change the order to prioritise the ticket related items further left.
+
+Relevant excerpt from the TracIni:
+{{{
+[trac]
+mainnav = wiki,tickets,newticket,timeline,roadmap,browser,search,admin
+}}}
+
+The default order and item names can be found in the source, which at the time of writing [source:trunk/trac/web/chrome.py@10883:397,402-403#L396 is here]
+
+=== Context Navigation #ctxtnav-bar
+
+Note that it is still not possible to customize the '''contextual navigation bar''', i.e. the one usually placed below the main navigation bar.
+
+
 ----
 See also: TracInterfaceCustomization, and the [http://trac-hacks.org/wiki/NavAddPlugin TracHacks:NavAddPlugin] or [http://trac-hacks.org/wiki/MenusPlugin TracHacks:MenusPlugin] (still needed for adding entries)