Permalink
Browse files

doc change: Add docs for SDK. Support new modular structure. In Andro…

…id.mk, change @since level identifier to 5.xml, expose adt downloadable vars. Fix links that pointed to @sdkCurrent.

Change-Id:I368345755dd753b1056fb06ff25e4b32f3020e4d
Bug:2160782
  • Loading branch information...
ddougherty committed Oct 16, 2009
1 parent 6797b9f commit ee58d1bf9c54eaed623c4419e1d9db269a9c4137
View
@@ -343,7 +343,7 @@ framework_docs_LOCAL_DROIDDOC_OPTIONS := \
-since ./frameworks/base/api/2.xml 2 \
-since ./frameworks/base/api/3.xml 3 \
-since ./frameworks/base/api/4.xml 4 \
- -since ./frameworks/base/api/current.xml Eclair \
+ -since ./frameworks/base/api/5.xml 5 \
-error 1 -error 2 -warning 3 -error 4 -error 6 -error 8 \
-overview $(LOCAL_PATH)/core/java/overview.html
@@ -380,10 +380,20 @@ framework_docs_SDK_CURRENT_DIR:=$(framework_docs_SDK_VERSION)_r$(framework_docs_
# flag to build offline docs for a preview release
framework_docs_SDK_PREVIEW:=0
+## Latest ADT version identifiers, for reference from published docs
+framework_docs_ADT_VERSION:=0.9.4
+framework_docs_ADT_DOWNLOAD:=ADT-0.9.4.zip
+framework_docs_ADT_BYTES:=0
+framework_docs_ADT_CHECKSUM:=0
+
framework_docs_LOCAL_DROIDDOC_OPTIONS += \
-hdf sdk.version $(framework_docs_SDK_VERSION) \
-hdf sdk.rel.id $(framework_docs_SDK_REL_ID) \
- -hdf sdk.current $(framework_docs_SDK_CURRENT_DIR)
+ -hdf sdk.current $(framework_docs_SDK_CURRENT_DIR) \
+ -hdf adt.zip.version $(framework_docs_ADT_VERSION) \
+ -hdf adt.zip.download $(framework_docs_ADT_DOWNLOAD) \
+ -hdf adt.zip.bytes $(framework_docs_ADT_BYTES) \
+ -hdf adt.zip.checksum $(framework_docs_ADT_CHECKSUM)
# ==== the api stubs and current.xml ===========================
include $(CLEAR_VARS)
@@ -83,6 +83,7 @@ Android platform.</p>
<table>
<tr><th>Platform Version</th><th>API Level</th></tr>
+ <tr><td>Android 2.0</td><td>5</td></tr>
<tr><td>Android 1.6</td><td>4</td></tr>
<tr><td>Android 1.5</td><td>3</td></tr>
<tr><td>Android 1.1</td><td>2</td></tr>
@@ -115,6 +116,10 @@ they are designed to support. The element offers two key attributes:</p>
<ul>
<li><code>android:minSdkVersion</code> &mdash; Specifies the minimum API Level
on which the application is able to run. The default value is "1".</li>
+<li><code>android:targetSdkVersion</code> &mdash; Specifies the API Level
+on which the application is designed to run. In some cases, this allows the
+application to use manifest elements or behaviors defined in the target
+API Level, rather than those in the minimum API Level.</li>
<li><code>android:maxSdkVersion</code> &mdash; Specifies the maximum API Level
on which the application is able to run.</li>
</ul>
@@ -146,7 +151,7 @@ element might look like this: </p>
<pre>&lt;manifest&gt;
...
- &lt;uses-sdk android:minSdkVersion="4" /&gt;
+ &lt;uses-sdk android:minSdkVersion="5" /&gt;
...
&lt;/manifest&gt;</pre>
@@ -288,23 +293,26 @@ a list of platform versions and their API Levels. </p>
<h2 id="provisional">Using a Provisional API Level</h2>
-<p>During an "Early Look" SDK release, the APIs may not be final, so the API Level integer
-will not be specified. You must instead use a provisional API Level in your application
-manifest in order to build applications against the Early Look platform. In this case,
-the provisional API Level is not an integer, but a string matching the codename of the
-unreleased platform version (for example, "Eclair"). The provisional API Level will be specified
-in the Early Look SDK release notes and is case-sensitive.</p>
-
-<p>The use of a provisional API Level is designed to protect developers
-and device users from inadvertently publishing or installing applications based on the
-Early Look framework API, which may not run properly on actual devices running the final
-system image.</p>
-
-<p>The provisional API Level will only be valid while using the Early Look SDK to run
-applications in the emulator. An application using the provisional API Level can never be
-installed on an Android device. When the final SDK is released, you must replace any
-instances of the provisional API Level in your application manifest with the final
-API Level integer.</p>
+<p>In some cases, an "Early Look" Android SDK platform may be available. To let
+you begin developing on the platform although the APIs may not be final, the
+platform's API Level integer will not be specified. You must instead use the
+platform's <em>provisional API Level</em> in your application manifest, in order
+to build applications against the platform. A provisional API Level is not an
+integer, but a string matching the codename of the unreleased platform version.
+The provisional API Level will be specified in the release notes for the Early
+Look SDK release notes and is case-sensitive.</p>
+
+<p>The use of a provisional API Level is designed to protect developers and
+device users from inadvertently publishing or installing applications based on
+the Early Look framework API, which may not run properly on actual devices
+running the final system image.</p>
+
+<p>The provisional API Level will only be valid while using the Early Look SDK
+and can only be used to run applications in the emulator. An application using
+the provisional API Level can never be installed on an Android device. At the
+final release of the platform, you must replace any instances of the provisional
+API Level in your application manifest with the final platform's actual API
+Level integer.</p>
<h2 id="filtering">Filtering the Reference Documentation by API Level</h2>
@@ -38,12 +38,12 @@ manifest and resource files.</li>
<p>To begin developing Android applications in the Eclipse IDE with ADT, you first need to
download the Eclipse IDE and then download and install the ADT plugin. To do so, follow the
-steps given in <a href="{@docRoot}sdk/{@sdkCurrent}/installing.html#installingplugin">Installing
+steps given in <a href="{@docRoot}sdk/eclipse-adt.html#installing">Installing
the ADT Plugin</a>.</p>
<p>If you are already developing applications using a version of ADT earlier than 0.9, make
sure to upgrade to the latest version before continuing. See the guide to
-<a href="{@docRoot}sdk/{@sdkCurrent}/upgrading.html#UpdateAdt">Updating Your Eclipse ADT Plugin</a>.</p>
+<a href="{@docRoot}sdk/eclipse-adt.html#updating">Updating Your ADT Plugin</a>.</p>
<p class="note"><strong>Note:</strong> This guide assumes you are using the latest version of
the ADT plugin. While most of the information covered also applies to previous
@@ -26,14 +26,14 @@ Android applications. </p>
<li>Create and update Android projects. See
<a href="{@docRoot}guide/developing/other-ide.html">Developing in Other IDEs</a>.</li>
<li>Update your Android SDK with new platforms, add-ons, and documentation. See
- <a href="{@docRoot}guide/developing/updating-sdk.html">Updating Your SDK</a>.</li>
+ <a href="{@docRoot}sdk/adding-components.html">Adding SDK Components</a>.</li>
</ul>
<p>If you develop in Eclipse with the ADT plugin, you can perform
these tasks directly from the IDE. To create
Android projects and AVDs from Eclipse, see <a href="{@docRoot}guide/developing/eclipse-adt.html">Developing
In Eclipse</a>. To update your SDK from Eclipse, see
-<a href="{@docRoot}guide/developing/updating-sdk.html">Updating Your SDK</a>.
+<a href="{@docRoot}sdk/adding-components.html">Adding SDK Components</a>.
</p>
@@ -29,7 +29,7 @@ You can then return to this tutorial and ignore anything about Eclipse.</p>
<p>Before you start, you should already have the very latest SDK installed, and if you're using
Eclipse, you should have installed the ADT plugin as well. If you have not installed these, see
-<a href="{@docRoot}sdk/{@sdkCurrent}/installing.html">Installing the Android SDK</a> and return
+<a href="{@docRoot}sdk/installing.html">Installing the Android SDK</a> and return
here when you've completed the installation.</p>
<h2 id="avd">Create an AVD</h2>
@@ -29,8 +29,8 @@ page.title=Eclipse 内で ADT を使用
<li>プロジェクトを、ユーザーに配布可能な署名済みの APK 形式でエクスポートすることもできます。</li>
</ul>
-<p>ADT を組み込んだ Eclipse 総合開発環境で Android アプリケーションの開発を始めるには、最初に Eclipse 総合開発環境をダウンロードしてから、ADT プラグインをダウンロードしてインストールする必要があります。そのためには、<a href="{@docRoot}sdk/{@sdkCurrent}/installing.html#installingplugin">Eclipse 用 ADT プラグインのインストール</a>に記載されている手順どおりに操作します。</p>
-<p>バージョン 0.9 より前の ADT を使用してアプリケーションを既に開発中の場合は、必ず最新バージョンにアップグレードしてから続行してください。<a href="{@docRoot}sdk/{@sdkCurrent}/upgrading.html#UpdateAdt">Eclipse ADT プラグインをアップデート</a>するためのガイドをご覧ください。</p>
+<p>ADT を組み込んだ Eclipse 総合開発環境で Android アプリケーションの開発を始めるには、最初に Eclipse 総合開発環境をダウンロードしてから、ADT プラグインをダウンロードしてインストールする必要があります。そのためには、<a href="{@docRoot}sdk/eclipse-adt.html#installing">Eclipse 用 ADT プラグインのインストール</a>に記載されている手順どおりに操作します。</p>
+<p>バージョン 0.9 より前の ADT を使用してアプリケーションを既に開発中の場合は、必ず最新バージョンにアップグレードしてから続行してください。<a href="{@docRoot}sdk/eclipse-adt.html#updating">Eclipse ADT プラグインをアップデート</a>するためのガイドをご覧ください。</p>
<p class="note"><strong>注:</strong> このガイドでは、ADT プラグインの最新バージョンを使用していることを前提としています。説明の大半は、以前のバージョンにも当てはまりますが、以前のバージョンを使用している場合は、このドキュメントのオンライン版ではなく、SDK パッケージに付属された資料内の同ドキュメントをご覧ください。</p>
@@ -20,7 +20,7 @@ page.title=Hello, World
<p>Eclipse を使用していない場合でも問題ありません。<a href="{@docRoot}guide/developing/other-ide.html">Developing in Other IDEs</a>に慣れてから、このチュートリアルに戻り、Eclipse に関する部分以外を参考にしてください。</p>
-<p>開始する前に、最新の SDK がインストールされている必要があります。また、Eclipse を使用する場合には、ADT プラグインもインストールされている必要があります。これらのプログラムがインストールされていない場合は、「<a href="{@docRoot}sdk/{@sdkCurrent}/installing.html">Installing the Android SDK</a>」を参考にインストールを実行して、完了後にこのチュートリアルに戻ってください。</p>
+<p>開始する前に、最新の SDK がインストールされている必要があります。また、Eclipse を使用する場合には、ADT プラグインもインストールされている必要があります。これらのプログラムがインストールされていない場合は、「<a href="{@docRoot}sdk/installing.html">Installing the Android SDK</a>」を参考にインストールを実行して、完了後にこのチュートリアルに戻ってください。</p>
<h2 id="avd">AVD の作成</h2>
@@ -2,7 +2,7 @@ page.title=Android SDK のインストール
@jd:body
-<p>このページでは、Android SDK をインストールして、開発環境を設定する方法について説明します。SDK をまだダウンロードしていない場合は、[<a href="{@docRoot}sdk/{@sdkCurrent}/index.html">ダウンロード</a>] ページからダウンロードしてください。SDK をダウンロードした後に、このページの手順を行ってください。</p>
+<p>このページでは、Android SDK をインストールして、開発環境を設定する方法について説明します。SDK をまだダウンロードしていない場合は、[<a href="{@docRoot}sdk/index.html">ダウンロード</a>] ページからダウンロードしてください。SDK をダウンロードした後に、このページの手順を行ってください。</p>
<p>インストール中に問題が発生した場合は、このページの下部にある<a href="#installnotes">インストールに関する注意事項</a>を参照してください。</p>
@@ -2,7 +2,7 @@ page.title=Android SDK のインストール
@jd:body
-<p>このページでは、Android SDK をインストールして、開発環境を設定する方法について説明します。SDK をまだダウンロードしていない場合は、[<a href="{@docRoot}sdk/{@sdkCurrent}/index.html">ダウンロード</a>] ページからダウンロードしてください。SDK をダウンロードした後に、このページの手順を行ってください。</p>
+<p>このページでは、Android SDK をインストールして、開発環境を設定する方法について説明します。SDK をまだダウンロードしていない場合は、[<a href="{@docRoot}sdk/index.html">ダウンロード</a>] ページからダウンロードしてください。SDK をダウンロードした後に、このページの手順を行ってください。</p>
<p>インストール中に問題が発生した場合は、このページの下部にある<a href="#installnotes">インストールに関する注意事項</a>を参照してください。</p>
View
@@ -10,17 +10,17 @@ page.title=Welcome
<h3>If you've downloaded the Android SDK for the first time...</h3>
-<p>Complete the online guide to
-<a href="http://developer.android.com/sdk/{@sdkCurrent}/installing.html">Installing
+<p>Follow the online guide to
+<a href="{@docRoot}sdk/installing.html">Installing
the Android SDK</a>, which will help you setup your development environment
(including the Android Development Tools plugin for Eclipse)
so you can start developing Android apps.</p>
<p>Once your environment is setup, look at the
-<a href="http://developer.android.com/sdk/{@sdkCurrent}/installing.html#NextSteps">Next
-Steps</a> for some pointers that will teach you about Android and get you started.</p>
+<a href="{@docRoot}sdk/installing.html#NextSteps">Next
+Steps</a> for some suggestions on how to begin learning about Android.</p>
-<h3>If you've updated an existing SDK using the <em>SDK and AVD Manager</em>...</h3>
+<h3>If you've just installed new SDK components using the <em>SDK and AVD Manager</em>...</h3>
<p>There's no additional setup.</p>
@@ -37,10 +37,11 @@ directory; and new documentation is saved in the existing
Android developer documentation. The offline documentation offers almost all the same
content and features as the online documentation. Because some features
such as search and videos are network-based, not everything will work if you
-are not connected to the Internet.<br/><br/>
-For the most current documentation and fully-functional experience, please visit<br/>
-<strong><a href="http://developer.android.com">
-http://developer.android.com</a></strong>.
+are not connected to the Internet.</p>
+
+<p>For the most current documentation and a fully-functional experience, please visit:</p>
+<p style="margin-left:2em;">
+<a href="http://developer.android.com">http://developer.android.com</a></strong>.
</p>
@@ -323,7 +323,7 @@ begin developing applications. Here are a few ways you can get started: </p>
<ul>
<li>If JDK is already installed on your development computer, please
take a moment to make sure that it meets the version requirements listed
- in the <a href="{@docRoot}sdk/{@sdkCurrent}/requirements.html">System Requirements</a>.
+ in the <a href="{@docRoot}sdk/requirements.html">System Requirements</a>.
In particular, note that some Linux distributions may include JDK 1.4 or Gnu
Compiler for Java, both of which are not supported for Android development.</li>
</ul>
@@ -323,7 +323,7 @@ begin developing applications. Here are a few ways you can get started: </p>
<ul>
<li>If JDK is already installed on your development computer, please
take a moment to make sure that it meets the version requirements listed
- in the <a href="{@docRoot}sdk/{@sdkCurrent}/requirements.html">System Requirements</a>.
+ in the <a href="{@docRoot}sdk/requirements.html">System Requirements</a>.
In particular, note that some Linux distributions may include JDK 1.4 or Gnu
Compiler for Java, both of which are not supported for Android development.</li>
</ul>
@@ -3,7 +3,50 @@ page.title=SDK Release Notes
<p>This document provides version-specific information about Android SDK
releases. For the latest known issues, please ensure that you're viewing this
-page at <a href="http://developer.android.com/sdk/RELEASENOTES.html">http://developer.android.com/sdk/RELEASENOTES.html</a>.</p>
+page at <a
+href="http://developer.android.com/sdk/RELEASENOTES.html">http://developer.
+android.com/sdk/RELEASENOTES.html</a>.</p>
+
+<h2 id="multiversion_r1">Android SDK</h2>
+
+<p>The Android SDK has changed! If you've worked with the Android SDK before,
+you will notice several important differences:</p>
+
+<ul>
+<li style="margin-top:.5em">The SDK downloadable package includes <em>only</em>
+the latest version of the Android SDK Tools.</li>
+<li>Once you've installed the SDK, you now use the Android SDK and AVD Manager
+to download all of the SDK components that you need, such as Android platforms,
+SDK add-ons, tools, and documentation. </li>
+<li>The new approach is modular &mdash; you can install only the components you
+need and update any or all components without affecting your development
+environment.</li>
+<li>In short, once you've installed the new SDK, you will not need to download
+an SDK package again. Instead, you will use the Android SDK and AVD Manager to
+keep your development environment up-to-date. </li>
+</ul>
+
+<p>Note that if you are currently using the Android 1.6 SDK, you do not
+necessarily need to install the new SDK, since your existing SDK incudes the
+Android SDK and AVD Manager tool. To develop against Android 2.0, for example,
+you could just download the Android 2.0 platform into your existing SDK. </p>
+
+<p>Release notes for Android platforms that are downloadable into the SDK are
+now available from the "SDK" tab, under "Downloadable SDK Components."</p>
+
+<ul>
+<li>Release notes for the Android 2.0 platform are in the <a
+href="{@docRoot}sdk/android-2.0.html">Android 2.0, Release 1</a> document. </li>
+<li>You can find information about tools changes in the <a
+href="{@docRoot}sdk/tools-notes.html">SDK Tools Notes</a> and <a
+href="{@docRoot}sdk/adt-notes.html">ADT Plugin Notes</a>.</li>
+</ul>
+
+<p>To get started with the SDK, review the Quick Start summary on the <a
+href="{@docRoot}sdk/index.html">Android SDK download page</a> or read <a
+href="{@docRoot}sdk/installing.html">Installing the SDK</a> for more
+information. </p>
+
<h2 id="1.6_r1">Android 1.6 SDK, Release 1</h2>
Oops, something went wrong.

0 comments on commit ee58d1b

Please sign in to comment.