AI 147058: am: CL 147054 am: CL 147053 Add -hdf primer vars for the platform and release ID associated with the current (most recent) SDK.
Currently, the docs that are specific to each SDK release -- downloading, installing, upgrading, requirements -- are stored in a directory with release-derived name, such as "1.1_r1". This change lets documents use generic links to point into the most recent version specific docs, eg href="{@docRoot}sdk/{sdkCurrent}/installing.html" instead of href="{@docRoot}sdk/1.1_r1/installing.html".
Original author: ddougherty
Merged from: //branches/cupcake/...
Original author: android-build
Automated import of CL 147058
diff --git a/tools/droiddoc/src/Comment.java b/tools/droiddoc/src/Comment.java
index 3a24357..3f1bf6c 100644
--- a/tools/droiddoc/src/Comment.java
+++ b/tools/droiddoc/src/Comment.java
@@ -47,6 +47,7 @@
"@deprecated",
"@undeprecate",
"@docRoot",
+ "@sdkCurrent",
"@inheritDoc",
"@more",
"@code",
diff --git a/tools/droiddoc/templates-sdk/customization.cs b/tools/droiddoc/templates-sdk/customization.cs
index 4a1dde6..384e43f 100644
--- a/tools/droiddoc/templates-sdk/customization.cs
+++ b/tools/droiddoc/templates-sdk/customization.cs
@@ -19,7 +19,7 @@
if:android.whichdoc != "online" ?>offline.html<?cs
else ?>index.html<?cs /if ?>">
<span>Home</span></a></li>
- <li id="sdk-link"><a href="<?cs var:toroot ?>sdk/1.1_r1/index.html"><span>SDK</span></a></li>
+ <li id="sdk-link"><a href="<?cs var:toroot ?>sdk/<?cs var:sdk.current ?>/index.html"><span>SDK</span></a></li>
<li id="guide-link"><a href="<?cs var:toroot ?>guide/index.html"
onClick="return loadLast('guide')"><span>Dev Guide</span></a></li>
<li id="reference-link"><a href="<?cs var:toroot ?>reference/packages.html"
@@ -115,7 +115,7 @@
</p><?cs
/def ?>
-<?cs # appears on the right side of the blue bar at the bottom of every page ?><?cs
+<?cs # appears on the right side of the blue bar at the bottom off every page ?><?cs
def:custom_buildinfo() ?>
- Android 1.1 r1 - <?cs var:page.now ?><?cs
-/def ?>
+ Android <?cs var:sdk.version ?> r<?cs var:sdk.rel.id ?> - <?cs var:page.now ?>
+<?cs /def ?>
diff --git a/tools/droiddoc/templates-sdk/sdkpage.cs b/tools/droiddoc/templates-sdk/sdkpage.cs
index b425da0..09f440e 100644
--- a/tools/droiddoc/templates-sdk/sdkpage.cs
+++ b/tools/droiddoc/templates-sdk/sdkpage.cs
@@ -4,7 +4,7 @@
<?cs if:sdk.redirect ?>
<head>
<title>Redirecting...</title>
- <meta http-equiv="refresh" content="0;url=<?cs var:toroot ?>sdk/<?cs var:sdk.redirect ?>/index.html">
+ <meta http-equiv="refresh" content="0;url=<?cs var:toroot ?>sdk/<?cs var:sdk.current ?>/index.html">
<link href="<?cs var:toroot ?>assets/android-developer-docs.css" rel="stylesheet" type="text/css" />
</head>
<?cs else ?>
@@ -21,14 +21,14 @@
<?cs if:sdk.redirect ?>
Redirecting to
- <a href="<?cs var:toroot ?>sdk/<?cs var:sdk.redirect ?>/index.html">
+ <a href="<?cs var:toroot ?>sdk/<?cs var:sdk.current ?>/index.html">
<?cs var:toroot ?>sdk/<?cs var:sdk.redirect ?>/index.html
</a>...
<?cs else ?>
<div id="jd-header" class="guide-header" >
<span class="crumb"> </span>
- <h1><?cs if:android.whichdoc == "online" ?>Download <?cs /if ?><?cs var:page.title ?></h1>
+ <h1><?cs if:android.whichdoc == "online" ?>Download <?cs /if ?><?cs var:sdk.self ?></h1>
</div>
@@ -52,7 +52,7 @@
<?cs else ?>
-<p>Before downloading, please read the <a href="<?cs var:toroot ?>sdk/<?cs var:sdk.version ?>/requirements.html">
+<p>Before downloading, please read the <a href="requirements.html">
System Requirements</a> document. As you start the download, you will also need to review and agree to
the Terms and Conditions that govern the use of the Android SDK. </p>
diff --git a/tools/droiddoc/templates/macros.cs b/tools/droiddoc/templates/macros.cs
index aec9c22..3ba743b 100644
--- a/tools/droiddoc/templates/macros.cs
+++ b/tools/droiddoc/templates/macros.cs
@@ -61,6 +61,9 @@
elif:tag.name == "@sample" ?><pre class="Code prettyprint"><?cs var:tag.text ?></pre><?cs
elif:tag.name == "@include" ?><?cs var:tag.text ?><?cs
elif:tag.kind == "@docRoot" ?><?cs var:toroot ?><?cs
+ elif:tag.kind == "@sdkCurrent" ?><?cs var:sdk.current ?><?cs
+ elif:tag.kind == "@sdkCurrentVersion" ?><?cs var:sdk.version ?><?cs
+ elif:tag.kind == "@sdkCurrentRelId" ?><?cs var:sdk.rel.id ?><?cs
elif:tag.kind == "@inheritDoc" ?><?cs # This is the case when @inheritDoc is in something
that doesn't inherit from anything?><?cs
elif:tag.kind == "@attr" ?><?cs
