<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Module: Sinatra::UrlForHelper</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Module</strong></td>
<td class="class-name-in-header">Sinatra::UrlForHelper</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../files/lib/sinatra/url_for_rb.html">
lib/sinatra/url_for.rb
</a>
<br />
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000243">api_url_for</a>
<a href="#M000245">root_url</a>
<a href="#M000244">url_for</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="constants-list">
<h3 class="section-bar">Constants</h3>
<div class="name-list">
<table summary="Constants">
<tr class="top-aligned-row context-row">
<td class="context-item-name">DEFAULT_URI_PREFIX</td>
<td>=</td>
<td class="context-item-value">"/api"</td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000243" class="method-detail">
<a name="M000243"></a>
<div class="method-heading">
<a href="UrlForHelper.src/M000243.html" target="Code" class="method-signature"
onclick="popupCode('UrlForHelper.src/M000243.html');return false;">
<span class="method-name">api_url_for</span><span class="method-args">(url_fragment, mode=:path_only)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000245" class="method-detail">
<a name="M000245"></a>
<div class="method-heading">
<a href="UrlForHelper.src/M000245.html" target="Code" class="method-signature"
onclick="popupCode('UrlForHelper.src/M000245.html');return false;">
<span class="method-name">root_url</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000244" class="method-detail">
<a name="M000244"></a>
<div class="method-heading">
<a href="UrlForHelper.src/M000244.html" target="Code" class="method-signature"
onclick="popupCode('UrlForHelper.src/M000244.html');return false;">
<span class="method-name">url_for</span><span class="method-args">(url_fragment, mode=:path_only)</span>
</a>
</div>
<div class="method-description">
<p>
Construct a link to <tt>url_fragment</tt>, which should be given relative
to the base of this <a href="../Sinatra.html">Sinatra</a> app. The mode
should be either <tt>:path_only</tt>, which will generate an absolute path
within the current domain (the default), or <tt>:full</tt>, which will
include the site name and port number. (The latter is typically necessary
for links in RSS feeds.) Example usage:
</p>
<pre>
url_for "/" # Returns "/myapp/"
url_for "/foo" # Returns "/myapp/foo"
url_for "/foo", :full # Returns "http://example.com/myapp/foo"
</pre>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
