Skip to content

Commit

Permalink
Update links in docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
@rgrove
rgrove committed Jul 15, 2011
1 parent bb25b42 commit 6d0f43b
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 54 deletions.
2 changes: 1 addition & 1 deletion src/autocomplete/docs/ac-datasource.mustache
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

<div class="intro">
<p>
This example demonstrates how to provide autocomplete suggestions using a <a href="http://developer.yahoo.com/yui/3/datasource/">DataSource</a> instance. While AutoComplete supports a variety of result sources without requiring a DataSource, using a DataSource can give you more control over how results are retrieved and processed, and also allows you to share data with other DataSource-based widgets on the page.
This example demonstrates how to provide autocomplete suggestions using a <a href="../datasource/index.html">DataSource</a> instance. While AutoComplete supports a variety of result sources without requiring a DataSource, using a DataSource can give you more control over how results are retrieved and processed, and also allows you to share data with other DataSource-based widgets on the page.
</p>

<p>
Expand Down
10 changes: 5 additions & 5 deletions src/autocomplete/docs/index.mustache
View file
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ For information on skinning the AutoComplete widget, see the [[#Skinning]] secti
<h3>Configuring AutoComplete</h3>

<p>
Except for `inputNode`, all configuration attributes are optional. These lists only contain the most interesting attributes. For a complete list of all attributes, please refer to the <a href="/yui/3/api/module_autocomplete.html">API docs</a>.
Except for `inputNode`, all configuration attributes are optional. These lists only contain the most interesting attributes. For a complete list of all attributes, please refer to the <a href="{{apiDocs}}/modules/autocomplete.html">API docs</a>.
</p>

<h4>Base Config Attributes</h4>
Expand Down Expand Up @@ -466,7 +466,7 @@ Y.one('#ac-input').plug(Y.Plugin.AutoComplete, {
```

<p>
See the <a href="/yui/3/api/WidgetPositionAlign.html">WidgetPositionAlign API docs</a> for more details on alignment configs.
See the <a href="{{apiDocs}}/classes/WidgetPositionAlign.html">WidgetPositionAlign API docs</a> for more details on alignment configs.
</p>

<h4>Using Query Delimiters</h4>
Expand Down Expand Up @@ -503,7 +503,7 @@ When the user selects an item from the result list, the selected item will repla
<h3>AutoComplete Events</h3>

<p>
These lists only contain the most interesting events. For a complete list, please refer to the <a href="/yui/3/api/module_autocomplete.html">API docs</a>.
These lists only contain the most interesting events. For a complete list, please refer to the <a href="{{apiDocs}}/modules/autocomplete.html">API docs</a>.
</p>

<h4>Base Events</h4>
Expand Down Expand Up @@ -738,7 +738,7 @@ Y.one('#ac-input').plug(Y.Plugin.AutoComplete, {
<h4>DataSource</h4>

<p>
Any <a href="../datasource/">YUI DataSource</a> instance may be used as a result source. This is useful if you want to share data between multiple components on a page, or if you need to parse data or apply a DataSchema in a way that isn't feasible with other AutoComplete sources.
Any <a href="../datasource/index.html">YUI DataSource</a> instance may be used as a result source. This is useful if you want to share data between multiple components on a page, or if you need to parse data or apply a DataSchema in a way that isn't feasible with other AutoComplete sources.
</p>

```
Expand Down Expand Up @@ -970,7 +970,7 @@ Not all results are simple strings. Sometimes a result is an object containing l
</p>

<p>
In the following sample, which is a subset of the data you might see in a response from the <a href="http://dev.twitter.com/doc/get/search">Twitter Search API</a>, an array of tweet objects is returned.
In the following sample, which is a subset of the data you might see in a response from the <a href="https://dev.twitter.com/docs/api/1/get/search">Twitter Search API</a>, an array of tweet objects is returned.
</p>

```
Expand Down
5 changes: 2 additions & 3 deletions src/common/docs/partials/getting-started.mustache
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ YUI().use({{{useParams}}}, function (Y) {

<p>
For more information on creating YUI instances and on the
<a href="http://developer.yahoo.com/yui/3/api/YUI.html#method_use">`use()`
method</a>, see the documentation for the
<a href="../yui/index.html">YUI Global object</a>.
<a href="{{apiDocs}}/classes/YUI.html#method_use">`use()` method</a>, see the
documentation for the <a href="../yui/index.html">YUI Global object</a>.
</p>
16 changes: 8 additions & 8 deletions src/history/docs/index.mustache
View file
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ If both the current URL and the `initialState` config property contain state inf
<h4>Adding, Replacing, and Getting State Values</h4>

<p>
Use the <code><a href="/yui/3/api/HistoryBase.html#method_add">add()</a></code> or <code><a href="/yui/3/api/HistoryBase.html#method_addValue">addValue()</a></code> methods to change the state and create a new browser history entry for the new state. The user can then navigate back to the previous state using the browser's back button, and forward again to the new state using the browser's forward button.
Use the <code><a href="{{apiDocs}}/classes/HistoryBase.html#method_add">add()</a></code> or <code><a href="{{apiDocs}}/classes/HistoryBase.html#method_addValue">addValue()</a></code> methods to change the state and create a new browser history entry for the new state. The user can then navigate back to the previous state using the browser's back button, and forward again to the new state using the browser's forward button.
</p>

<p>
Expand Down Expand Up @@ -183,7 +183,7 @@ history.addValue('sloths', 'slow', {merge: false});
```

<p>
The <code><a href="/yui/3/api/HistoryBase.html#method_replace">replace()</a></code> and <code><a href="/yui/3/api/HistoryBase.html#method_replaceValue">replaceValue()</a></code> methods work just like `add()` and `addValue()`, except that they replace the current browser history entry instead of adding a new entry.
The <code><a href="{{apiDocs}}/classes/HistoryBase.html#method_replace">replace()</a></code> and <code><a href="{{apiDocs}}/classes/HistoryBase.html#method_replaceValue">replaceValue()</a></code> methods work just like `add()` and `addValue()`, except that they replace the current browser history entry instead of adding a new entry.
</p>

```
Expand All @@ -200,7 +200,7 @@ history.replace({
```

<p>
Use the <code><a href="/yui/3/api/HistoryBase.html#method_get">get()</a></code> method to get the current state, or the value of a single item in the current state.
Use the <code><a href="{{apiDocs}}/classes/HistoryBase.html#method_get">get()</a></code> method to get the current state, or the value of a single item in the current state.
</p>

```
Expand Down Expand Up @@ -237,7 +237,7 @@ The History Utility fires events when the history state changes. Changes can be
<h4>history:change Event</h4>

<p>
There are several ways to subscribe to History events. The most common is to subscribe to the global <code><a href="/yui/3/api/HistoryBase.html#event_history%3Achange">history:change</a></code> event. This event fires whenever the history state changes for any reason, regardless of the source of the change, even if it came from a different History or YUI instance.
There are several ways to subscribe to History events. The most common is to subscribe to the global <code><a href="{{apiDocs}}/classes/HistoryBase.html#event_history%3Achange">history:change</a></code> event. This event fires whenever the history state changes for any reason, regardless of the source of the change, even if it came from a different History or YUI instance.
</p>

```
Expand Down Expand Up @@ -270,7 +270,7 @@ history.on('change', function (e) {
<h4>Property-specific Events</h4>

<p>
To be notified when a specific state property is added or changed, subscribe to the instance-level <code><a href="/yui/3/api/HistoryBase.html#event_%5Bkey%5DChange">[key]Change</a></code> event, where `[key]` is the name of the property. To be notified when a state property is removed, subscribe to <code><a href="/yui/3/api/HistoryBase.html#event_%5Bkey%5DRemove">[key]Remove</a></code>.
To be notified when a specific state property is added or changed, subscribe to the instance-level <code><a href="{{apiDocs}}/classes/HistoryBase.html#event_%5Bkey%5DChange">[key]Change</a></code> event, where `[key]` is the name of the property. To be notified when a state property is removed, subscribe to <code><a href="{{apiDocs}}/classes/HistoryBase.html#event_%5Bkey%5DRemove">[key]Remove</a></code>.
</p>

```
Expand All @@ -288,7 +288,7 @@ history.on('kittensRemove', function (e) {
```

<p>
See the <a href="/yui/3/api/HistoryBase.html#events">API docs</a> for more details.
See the <a href="{{apiDocs}}/classes/HistoryBase.html#events">API docs</a> for more details.
</p>

<h4>Filtering by Event Source</h4>
Expand Down Expand Up @@ -455,7 +455,7 @@ Versions of YUI 3 prior to 3.2.0 included the Browser History Manager. In YUI 3.
<h3>API Equivalency: Methods</h3>

<p>
The table below provides a quick reference to help you translate API methods from the deprecated Browser History Manager to the new History Utility. See the <a href="/yui/3/api/HistoryBase.html#methods">API documentation</a> for details on the new API.
The table below provides a quick reference to help you translate API methods from the deprecated Browser History Manager to the new History Utility. See the <a href="{{apiDocs}}/classes/HistoryBase.html#methods">API documentation</a> for details on the new API.
</p>

<table>
Expand Down Expand Up @@ -497,7 +497,7 @@ The table below provides a quick reference to help you translate API methods fro
<h3>API Equivalency: Events</h3>

<p>
The table below provides a quick reference to help you translate API events from the deprecated Browser History Manager to the new History Utility. See the <a href="/yui/3/api/HistoryBase.html#events">API documentation</a> for details on the new API.
The table below provides a quick reference to help you translate API events from the deprecated Browser History Manager to the new History Utility. See the <a href="{{apiDocs}}/classes/HistoryBase.html#events">API documentation</a> for details on the new API.
</p>

<table>
Expand Down
53 changes: 17 additions & 36 deletions src/node-menunav/docs/index.mustache
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
{{! TODO: Update Example and doc link URLs }}

<div class="intro">
<p>
The MenuNav Node Plugin makes it easy to transform existing list-based
Expand All @@ -20,13 +18,7 @@
<dt>Small footprint</dt>
<dd>
The MenuNav Node Plugin has a small footprint of ~5 KB (GZIP'd) and
requires a minimal set of dependencies (<a href="../api/module_yui.html">YUI</a>,
<a href="../api/module_event.html">Event</a>,
<a href="../api/module_dom.html">DOM</a>,
<a href="../api/module_node.html">Node</a>,
<a href="../api/module_oop.html">OOP</a>,
<a href="../api/module_classnamemanager.html">ClassNameManager</a>,
and the <a href="../api/module_node-focusmanager.html">Focus Manager Node Plugin</a>).
requires a minimal set of dependencies.
</dd>

<dt>Accessibility &#38; Usability Minded</dt>
Expand All @@ -37,10 +29,6 @@
familiar and easy to use. To that foundation the MenuNav Node plugin
adds support for screen readers through the use of the
<a href="http://www.w3.org/TR/wai-aria/">WAI-ARIA Roles and States</a>.
<a href="http://video.yahoo.com/watch/4059872/10967271">Watch this video</a>
for a quick a demo of a menu created using the MenuNav Node Plugin
using the WAI-ARIA Roles and States running in Firefox 3 using the
Window-Eyes screen reader.
</dd>

<dt>Easy to style and configure</dt>
Expand Down Expand Up @@ -72,18 +60,11 @@ simply by putting the class on the `<body>` tag:
<body class="yui3-skin-sam">
```

<p>
For more information on skinning YUI components and making use of default
skins, see our
<a href="http://developer.yahoo.com/yui/articles/skinning/">Understanding YUI Skins</a>
article.
</p>

<h3 id="setup">Basic Setup</h3>

<p>
To create a menu using the MenuNav Node Plugin, start by including the required markup. The markup
for menus created using the MenuNav Node Plugin follows the same <a href="../widget/#markup">pattern established for Widgets</a>,
for menus created using the MenuNav Node Plugin follows the same <a href="../widget/index.html#markup">pattern established for Widgets</a>,
with each menu's content box containing one or more `<ul>` elements:
</p>

Expand Down Expand Up @@ -177,7 +158,7 @@ Plugin comes together as follows:

<p>
With the markup for the menu in place, simply get a Node reference for the root menu and then call
the <a href="../api/Node.html#method_plug"><code>plug</code></a> method, passing in a reference to the MenuNav Node Plugin.
the <a href="{{apiDocs}}/classes/Node.html#method_plug"><code>plug</code></a> method, passing in a reference to the MenuNav Node Plugin.
</p>

```
Expand Down Expand Up @@ -235,7 +216,7 @@ horizontal orientation. The default "Sam" skin provides the following default v
horizontal menus, as illustrated in the follow screen capture of a horizontal menu example:
</p>

<div class="wideimage"><a href="../examples/node-menunav/node-menunav-2.html"><img src="{{componentAssets}}/horizontal-menu.png" width="495" height="130" alt="Screen capture of a horizontal menu rendered with the default Sam Skin"></a></div>
<div class="wideimage"><img src="{{componentAssets}}/horizontal-menu.png" width="495" height="130" alt="Screenshot of a horizontal menu rendered with the default Sam Skin"></div>

<h4>Configuring Style &amp; Behavior</h4>

Expand All @@ -253,7 +234,7 @@ each menu label as a menu button; each menu label is rendered with an arrow to t
of its text label, providing a visual cue that there is a corresponding submenu.
</p>

<div class="wideimage"><a href="../examples/node-menunav/node-menunav-3.html"><img src="{{componentAssets}}/menubutton-menu.png" width="495" height="130" alt="Screen capture of a horizontal menu with each menu label in the root menu rendered as menu buttons."></a></div>
<div class="wideimage"><img src="{{componentAssets}}/menubutton-menu.png" width="495" height="130" alt="Screen capture of a horizontal menu with each menu label in the root menu rendered as menu buttons."></div>

<p>
To apply this style to a horizontal menu, start by adding the class <code>yui3-menubuttonnav</code>
Expand Down Expand Up @@ -295,8 +276,8 @@ to the node representing the root menu's bounding box, as illustrated in the fol

<p>
As a final, optional step, use the
<a href="../api/plugin.NodeMenuNav.html#config_autoSubmenuDisplay"><code>autoSubmenuDisplay</code></a>
and <a href="../api/plugin.NodeMenuNav.html#config_mouseOutHideDelay"><code>mouseOutHideDelay</code></a>
<a href="{{apiDocs}}/classes/plugin.NodeMenuNav.html#config_autoSubmenuDisplay"><code>autoSubmenuDisplay</code></a>
and <a href="{{apiDocs}}/classes/plugin.NodeMenuNav.html#config_mouseOutHideDelay"><code>mouseOutHideDelay</code></a>
configuration attributes to configure the menu labels to behave like menu buttons. Set the
<code>autoSubmenuDisplay</code> to <code>false</code>, so that each menu label's submenu isn't
made visible until the label is clicked. Set the <code>mouseOutHideDelay</code> to
Expand Down Expand Up @@ -336,7 +317,7 @@ The other optional horizontal menu visualization available with the "Sam" skin r
label as a split button.
</p>

<div class="wideimage"><a href="../examples/node-menunav/node-menunav-4.html"><img src="{{componentAssets}}/splitbutton-menu.png" width="495" height="130" alt="Screen capture of a horizontal menu with each menu label in the root menu rendered as split buttons."></a></div>
<div class="wideimage"><img src="{{componentAssets}}/splitbutton-menu.png" width="495" height="130" alt="Screen capture of a horizontal menu with each menu label in the root menu rendered as split buttons."></div>

<p>To apply this style to a horizontal menu, start by adding the class
<code>yui3-splitbuttonnav</code> to the node representing the root menu's bounding box, as
Expand Down Expand Up @@ -396,8 +377,8 @@ attribute to the id of the label's corresponding submenu. Lastly, the text node
```

<p>
Use the <a href="../../api/plugin.NodeMenuNav.html#config_autoSubmenuDisplay"><code>autoSubmenuDisplay</code></a>
and <a href="../../api/plugin.NodeMenuNav.html#config_mouseOutHideDelay"><code>mouseOutHideDelay</code></a>
Use the <a href="{{apiDocs}}/classes/plugin.NodeMenuNav.html#config_autoSubmenuDisplay"><code>autoSubmenuDisplay</code></a>
and <a href="{{apiDocs}}/classes/plugin.NodeMenuNav.html#config_mouseOutHideDelay"><code>mouseOutHideDelay</code></a>
configuration attributes to configure the menu labels to behave like split buttons. Set the
<code>autoSubmenuDisplay</code> to <code>false</code>, so that each menu label's submenu isn't
made visible until the menu trigger is clicked. Set the <code>mouseOutHideDelay</code> to
Expand Down Expand Up @@ -470,7 +451,7 @@ With the separator markup in place, the default "Sam" skin will render a top bor
MenuNav Node Plugin examples:
</p>

<div class="wideimage"><a href="../examples/node-menunav/node-menunav-2.html"><img src="{{componentAssets}}/menuitem-separators.png" width="495" height="250" alt="Screen capture of a horizontal menu"></a></div>
<div class="wideimage"><img src="{{componentAssets}}/menuitem-separators.png" width="495" height="250" alt="Screen capture of a horizontal menu"></div>

<h3>Styling State</h3>

Expand Down Expand Up @@ -513,7 +494,7 @@ and a class <code>yui3-menu-label-menuvisible</code> is applied to the submenu's
<p>
The MenuNav Node Plugin has several configuration attributes that can be set via an object literal
that is passed as a second argument to a Node instance's
<a href="../api/Node.html#method_plug"><code>plug</code></a> method. (<em>Note:</em> These
<a href="{{apiDocs}}/classes/Node.html#method_plug"><code>plug</code></a> method. (<em>Note:</em> These
attributes are <em>case sensitive</em>.) In the following example, the value of the
<code>mouseOutHideDelay</code> attribute is set to 1000.
</p>
Expand Down Expand Up @@ -566,7 +547,7 @@ oMenuNav.plug(Y.Plugin.NodeMenuNav, { mouseOutHideDelay: 1000 });

<p>
The MenuNav Node Plugin publishes no custom events of its own. To listen for any DOM-related
events for a menu built using the MenuNav Node Plugin, use the <a href="../api/Node.html#method_on"><code>on</code></a> method of the
events for a menu built using the MenuNav Node Plugin, use the <a href="{{apiDocs}}/classes/Node.html#method_on"><code>on</code></a> method of the
plugin's host Node instance. The following example illustrates how to listen for the
<code>click</code> event of menu a built using the MenuNav Node Plugin:
</p>
Expand All @@ -587,8 +568,8 @@ oMenuNode.on("click", function () {
```

<p>For additional information on listening for DOM-related events, see the
<a href="../node/#node-events">DOM Events</a> section of the
<a href="../node/">Node landing page</a>.
<a href="../node/index.html#node-events">DOM Events</a> section of the
<a href="../node/index.html">Node landing page</a>.
</p>

<h3>`<iframe>` Shim</h3>
Expand All @@ -607,15 +588,15 @@ and is therefore a sibling of the the a submenu's content box. All styling of t
`<iframe>` is handled by the core CSS file for the MenuNav Node Plugin, so
authors of custom skins won't have to worry about it. The markup template used to create each
`<iframe>` is accessible via the
<a href="../api/Y.Plugin.NodeMenuNav.html#property_NodeMenuNav.SHIM_TEMPLATE"><code>SHIM_TEMPLATE</code></a> property.
<a href="{{apiDocs}}/classes/Plugin.NodeMenuNav.html#property_NodeMenuNav.SHIM_TEMPLATE"><code>SHIM_TEMPLATE</code></a> property.
</p>

<p>
To help users of screen readers to avoid mistakenly interacting with the
`<iframe>` shim, its <code>tabindex</code> attribute is set to "-1" and its
title attribute is set to "Menu Stacking Shim". The value of the `<iframe>`'s
<code>title</code> attribute is available via the
<a href="../api/Y.Plugin.NodeMenuNav.html#property_NodeMenuNav.SHIM_TEMPLATE_TITLE"><code>SHIM_TEMPLATE_TITLE</code></a>
<a href="{{apiDocs}}/classes/Plugin.NodeMenuNav.html#property_NodeMenuNav.SHIM_TEMPLATE_TITLE"><code>SHIM_TEMPLATE_TITLE</code></a>
property for easy localization. Lastly, the <code>src</code> attribute of the
`<iframe>` is set to "javascript:false;" so that it won't load a
page inside it, preventing the secure/nonsecure warning in IE when using the MenuNav Node Plugin
Expand Down
Loading

0 comments on commit 6d0f43b

Please sign in to comment.