diff options
author | jmedley <jmedley@chromium.org> | 2014-08-25 09:41:52 -0700 |
---|---|---|
committer | Commit bot <commit-bot@chromium.org> | 2014-08-25 16:43:06 +0000 |
commit | d8030556408b675d29fd0446a10eeba50b2a2c84 (patch) | |
tree | 1d890fd13b813771b73e439d5b75566b43aab754 /native_client_sdk/doc_generated/devguide | |
parent | 4963830383cd11d5ad000504a3f9dcc49ec122d4 (diff) | |
download | chromium_src-d8030556408b675d29fd0446a10eeba50b2a2c84.zip chromium_src-d8030556408b675d29fd0446a10eeba50b2a2c84.tar.gz chromium_src-d8030556408b675d29fd0446a10eeba50b2a2c84.tar.bz2 |
Per P0 reqs add launch points + make download obvious. Also misc copy edits.
BUG=none
R= mkearney@chromium.org, smain@chromium.org, binji@chromium.org
TEST=none
NOTRY=true
(documentation only change)
Priority list copied here for reference:
P1 But written by different engineers, very uneven quality and voice.
P2 Some documentation could be expanded.
P0 The ramp-in for new users could be improved.
P0 The landing page isn't "cool", it doesn't make developers want to jump in and use it.
Could we have a more github-like thing that gets people started quickly?
Could we have a narrative intro?
We just bought the pna.cl domain, we should use it!
P3 We think it's pretty important to keep the deep-dive in there (e.g. sandbox internals, bitcode reference).
Review URL: https://codereview.chromium.org/476793002
Cr-Commit-Position: refs/heads/master@{#291696}
Diffstat (limited to 'native_client_sdk/doc_generated/devguide')
9 files changed, 31 insertions, 31 deletions
diff --git a/native_client_sdk/doc_generated/devguide/coding/application-structure.html b/native_client_sdk/doc_generated/devguide/coding/application-structure.html index 3391274..f53fd4e 100644 --- a/native_client_sdk/doc_generated/devguide/coding/application-structure.html +++ b/native_client_sdk/doc_generated/devguide/coding/application-structure.html @@ -11,8 +11,8 @@ <li><a class="reference internal" href="#native-client-modules-a-closer-look" id="id5">Native Client modules: A closer look</a></li> </ul> -</div><p>This chapter of the Developer’s Guide describes the general structure of a -Native Client application. The chapter assumes you are familiar with the +</div><p>This section of the Developer’s Guide describes the general structure of a +Native Client application. The section assumes you are familiar with the material presented in the <a class="reference internal" href="/native-client/overview.html"><em>Technical Overview</em></a>.</p> <aside class="note"> The “Hello, World” example is used here to illustrate basic @@ -204,7 +204,7 @@ issue a <code>crash</code> event <a class="reference internal" href="/native-client/devguide/coding/progress-events.html"><em>which can be handled in Javascript</em></a>.</p> <p>While the <code>CreateModule()</code> factory function, the <code>Module</code> class, and the <code>Instance</code> class are required for a Native Client application, the code -samples shown above don’t actually do anything. Subsequent chapters in the +samples shown above don’t actually do anything. Subsequent sections in the Developer’s Guide build on these code samples and add more interesting functionality.</p> </section> diff --git a/native_client_sdk/doc_generated/devguide/coding/audio.html b/native_client_sdk/doc_generated/devguide/coding/audio.html index 875ae15..6177b5c 100644 --- a/native_client_sdk/doc_generated/devguide/coding/audio.html +++ b/native_client_sdk/doc_generated/devguide/coding/audio.html @@ -24,7 +24,7 @@ <li><a class="reference internal" href="#starting-and-stopping-playback" id="id12">Starting and stopping playback</a></li> </ul> -</div><p>This chapter describes how to use the Pepper audio API to play an audio +</div><p>This section describes how to use the Pepper audio API to play an audio stream. The Pepper audio API provides a low-level means of playing a stream of audio samples generated by a Native Client module. The API generally works as follows: A Native Client module creates an audio resource that represents an @@ -32,7 +32,7 @@ audio stream, and tells the browser to start or stop playing the audio resource. The browser calls a function in the Native Client module to fill a buffer with audio samples every time it needs data to play from the audio stream.</p> -<p>The code examples in this chapter describe a simple Native Client module that +<p>The code examples in this section describe a simple Native Client module that generates audio samples using a sine wave with a frequency of 440 Hz. The module starts playing the audio samples as soon as it is loaded into the browser. For a slightly more sophisticated example, see the <code>audio</code> example (source code in diff --git a/native_client_sdk/doc_generated/devguide/coding/file-io.html b/native_client_sdk/doc_generated/devguide/coding/file-io.html index ac784c5..571415f 100644 --- a/native_client_sdk/doc_generated/devguide/coding/file-io.html +++ b/native_client_sdk/doc_generated/devguide/coding/file-io.html @@ -36,7 +36,7 @@ </ul> </div><h2 id="introduction">Introduction</h2> -<p>This chapter describes how to use the <a class="reference external" href="/native-client/pepper_stable/cpp/classpp_1_1_file_i_o">FileIO API</a> to read and write +<p>This section describes how to use the <a class="reference external" href="/native-client/pepper_stable/cpp/classpp_1_1_file_i_o">FileIO API</a> to read and write files using a local secure data store.</p> <p>You might use the File IO API with the URL Loading APIs to create an overall data download and caching solution for your NaCl applications. For example:</p> @@ -50,7 +50,7 @@ file from the server.</li> <li>Load the file into memory using the File IO API when needed by your application.</li> </ol> -<p>The example discussed in this chapter is included in the SDK in the directory +<p>The example discussed in this section is included in the SDK in the directory <code>examples/api/file_io</code>.</p> <h2 id="reference-information">Reference information</h2> <p>For reference information related to FileIO, see the following documentation:</p> diff --git a/native_client_sdk/doc_generated/devguide/coding/message-system.html b/native_client_sdk/doc_generated/devguide/coding/message-system.html index a93ab07..f3013ae 100644 --- a/native_client_sdk/doc_generated/devguide/coding/message-system.html +++ b/native_client_sdk/doc_generated/devguide/coding/message-system.html @@ -31,13 +31,13 @@ </li> </ul> -</div><p>This chapter describes the messaging system used to communicate between the +</div><p>This section describes the messaging system used to communicate between the JavaScript code and the Native Client module’s C or C++ code in a Native Client application. It introduces the concept of asynchronous programming and the basic steps required to set up a Native Client module -that sends messages to and receive messages from JavaScript. This chapter +that sends messages to and receive messages from JavaScript. This section assumes you are familiar with the material presented in the -<a class="reference internal" href="/native-client/devguide/coding/application-structure.html"><em>Application Structure</em></a> chapter.</p> +<a class="reference internal" href="/native-client/devguide/coding/application-structure.html"><em>Application Structure</em></a> section.</p> <aside class="note"> The “Hello, World” example for getting started with NaCl is used here to illustrate basic programming techniques. You can find this code in diff --git a/native_client_sdk/doc_generated/devguide/coding/progress-events.html b/native_client_sdk/doc_generated/devguide/coding/progress-events.html index afca37c..94f1870 100644 --- a/native_client_sdk/doc_generated/devguide/coding/progress-events.html +++ b/native_client_sdk/doc_generated/devguide/coding/progress-events.html @@ -14,9 +14,9 @@ </div><p>There are five types of events that developers can respond to in Native Client: progress, message, view change, focus, and input events (each described in the -glossary below). This chapter describes how to monitor progress events (events +glossary below). This section describes how to monitor progress events (events that occur during the loading and execution of a Native Client module). This -chapter assumes you are familiar with the material presented in the +section assumes you are familiar with the material presented in the <a class="reference internal" href="/native-client/overview.html"><em>Technical Overview</em></a>.</p> <aside class="note"> The load_progress example illustrates progress event handling. You can find diff --git a/native_client_sdk/doc_generated/devguide/coding/url-loading.html b/native_client_sdk/doc_generated/devguide/coding/url-loading.html index 6465d5e..895dc00 100644 --- a/native_client_sdk/doc_generated/devguide/coding/url-loading.html +++ b/native_client_sdk/doc_generated/devguide/coding/url-loading.html @@ -22,9 +22,9 @@ </ul> </div><h2 id="introduction">Introduction</h2> -<p>This chapter describes how to use the <a class="reference external" href="/native-client/pepper_stable/cpp/classpp_1_1_u_r_l_loader">URLLoader API</a> to load resources +<p>This section describes how to use the <a class="reference external" href="/native-client/pepper_stable/cpp/classpp_1_1_u_r_l_loader">URLLoader API</a> to load resources such as images and sound files from a server into your application.</p> -<p>The example discussed in this chapter is included in the SDK in the directory +<p>The example discussed in this section is included in the SDK in the directory <code>examples/api/url_loader</code>.</p> <h2 id="reference-information">Reference information</h2> <p>For reference information related to loading data from URLs, see the @@ -42,7 +42,7 @@ following documentation:</p> caches your application’s HTML file, manifest file (.nmf), and Native Client module (.pexe or .nexe). If your application needs additional assets, such as images and sound files, it must explicitly load those assets. You can use the -Pepper APIs described in this chapter to load assets from a URL into your +Pepper APIs described in this section to load assets from a URL into your application.</p> <p>After you’ve loaded assets into your application, Chrome will cache those assets. To avoid being at the whim of the Chrome cache, however, you may want diff --git a/native_client_sdk/doc_generated/devguide/coding/view-focus-input-events.html b/native_client_sdk/doc_generated/devguide/coding/view-focus-input-events.html index fd2daed..a73a90b 100644 --- a/native_client_sdk/doc_generated/devguide/coding/view-focus-input-events.html +++ b/native_client_sdk/doc_generated/devguide/coding/view-focus-input-events.html @@ -20,10 +20,10 @@ </li> </ul> -</div><p>This chapter describes view change, focus, and input event handling for a -Native Client module. The chapter assumes you are familiar with the +</div><p>This section describes view change, focus, and input event handling for a +Native Client module. The section assumes you are familiar with the material presented in the <a class="reference internal" href="/native-client/overview.html"><em>Technical Overview</em></a>.</p> -<p>There are two examples used in this chapter to illustrate basic +<p>There are two examples used in this section to illustrate basic programming techniques. The <code>input_events</code> example is used to illustrate how your module can react to keyboard and mouse input event. The <code>mouse_lock</code> example is used to illustrate how your module diff --git a/native_client_sdk/doc_generated/devguide/devcycle/running.html b/native_client_sdk/doc_generated/devguide/devcycle/running.html index c34060c..20eeeaf 100644 --- a/native_client_sdk/doc_generated/devguide/devcycle/running.html +++ b/native_client_sdk/doc_generated/devguide/devcycle/running.html @@ -372,7 +372,7 @@ etc.)</li> <li>Upload the application files (.html, .nmf, .nexe, .css, .js, image files, etc.) to the server on which the application is being hosted.</li> <li>Use <a class="reference external" href="http://www.google.com/webmasters/tools/">Google Webmaster Tools</a> to -verify ownership of the web site on which the application runs.</li> +verify ownership of the website on which the application runs.</li> </ul> </li> <li>Log in to the <a class="reference external" href="https://chrome.google.com/webstore/developer/dashboard">Chrome Web Store Developer Dashboard</a>.<ul class="small-gap"> diff --git a/native_client_sdk/doc_generated/devguide/tutorial/tutorial-part1.html b/native_client_sdk/doc_generated/devguide/tutorial/tutorial-part1.html index 8664bb8..25922ce 100644 --- a/native_client_sdk/doc_generated/devguide/tutorial/tutorial-part1.html +++ b/native_client_sdk/doc_generated/devguide/tutorial/tutorial-part1.html @@ -27,19 +27,19 @@ Client (PNaCl). This is a client-side application that uses HTML, JavaScript and a Native Client module written in C++. The PNaCl toolchain is used to enable running the Native Client module directly from a web page.</p> -<p>It’s recommended to read the <a class="reference internal" href="/native-client/overview.html"><em>Native Client Technical Overview</em></a> prior to going through this tutorial.</p> +<p>It’s recommended that you read the <a class="reference internal" href="/native-client/overview.html"><em>Native Client Technical Overview</em></a> prior to going through this tutorial.</p> <h3 id="what-the-application-in-this-tutorial-does">What the application in this tutorial does</h3> <p>The application in this tutorial shows how to load a Native Client module in a -web page, and how to send messages between JavaScript and the C++ code in the -Native Client module. In this simple application, the JavaScript code in the web -page sends a <code>'hello'</code> message to the Native Client module. When the Native -Client module receives a message, it checks whether the message is equal to the -string <code>'hello'</code>. If it is, the Native Client module returns a message saying -<code>'hello from NaCl'</code>. A JavaScript alert panel displays the message received -from the Native Client module.</p> +web page, and how to send messages between JavaScript and the Native Client +module. In this simple application, the JavaScript sends a <code>'hello'</code> message +to the Native Client module. When the Native Client module receives a message, +it checks whether the message is equal to the string <code>'hello'</code>. If it is, the +Native Client module returns a message saying <code>'hello from NaCl'</code>. A +JavaScript alert panel displays the message received from the Native Client +module.</p> <h3 id="communication-between-javascript-and-native-client-modules">Communication between JavaScript and Native Client modules</h3> <p>The Native Client programming model supports bidirectional communication between -JavaScript and the Native Client module (C/C++ code). Both sides can initiate +JavaScript and the Native Client module. Both sides can initiate and respond to messages. In all cases, the communication is asynchronous: The caller (JavaScript or the Native Client module) sends a message, but the caller does not wait for, or may not even expect, a response. This behavior is @@ -65,8 +65,8 @@ The SDK may consist of several “bundles”, one per Chrome/Pepper vers <a class="reference internal" href="/native-client/version.html"><em>versioning information</em></a>). In the sample invocation above <code>pepper_$(VERSION)</code> refers to the specific version you want to use. For example, <code>pepper_31</code>. If you don’t know which version you need, use the -one labeled <code>(stable)</code> by <code>naclsdk list</code>. See <a class="reference internal" href="/native-client/sdk/download.html"><em>Download the Native -Client SDK</em></a> for more details. +one labeled <code>(stable)</code> by the <code>naclsdk list</code> command. See +<a class="reference internal" href="/native-client/sdk/download.html"><em>Download the Native Client SDK</em></a> for more details. </aside> <p>If no port number is specified, the server defaults to port 5103, and can be accessed at <code>http://localhost:5103</code>.</p> @@ -214,7 +214,7 @@ contains some useful information about handling error events.</li> <h2 id="next-steps">Next steps</h2> <ul class="small-gap"> <li>See the <a class="reference internal" href="/native-client/devguide/coding/application-structure.html"><em>Application Structure</em></a> -chapter in the Developer’s Guide for information about how to structure a +section in the Developer’s Guide for information about how to structure a Native Client module.</li> <li>Check the <a class="reference external" href="/native-client/pepper_stable/cpp">C++ Reference</a> for details about how to use the Pepper APIs.</li> |