[gnome-devel-docs] tutorials <javascript>: Cleaned up chapter one's code and markup



commit 98ccdd0e521c85aa8d7ee6952895f06a753e39fb
Author: Taryn Fox <jewelfox fursona net>
Date:   Tue Aug 14 10:59:48 2012 -0400

    tutorials <javascript>: Cleaned up chapter one's code and markup

 platform-demos/C/hellognome.js.page    |   31 +++++++++++++++----------------
 platform-demos/C/samples/hellognome.js |    3 +--
 2 files changed, 16 insertions(+), 18 deletions(-)
---
diff --git a/platform-demos/C/hellognome.js.page b/platform-demos/C/hellognome.js.page
index d5400f8..439bf0c 100644
--- a/platform-demos/C/hellognome.js.page
+++ b/platform-demos/C/hellognome.js.page
@@ -63,7 +63,7 @@
 
     <media type="image" mime="image/png" src="media/hellognomewebapp.png"/>
 
-    <p>You <em>can</em> run the above code by opening <file>hellognome.html</file> in a web browser. But here, we're going to create a GNOME application that runs our web app inside of it, just like you see in the screenshot. You'll be able to resize and maximize the window, and click the <input>X</input> in the corner to close it, just like you'd expect from any other GNOME app. The difference is that this one will run our web code inside of it.</p>
+    <p>You <em>can</em> run the above code by opening <file>hellognome.html</file> in a web browser. But here, we're going to create a GNOME application that runs our web app inside of it, just like you see in the screenshot. You'll be able to resize and maximize the window, and click the X in the corner to close it, just like you'd expect from any other GNOME app. The difference is that this one will run our web code inside of it.</p>
     <p>The best part? We're going to continue to use JavaScript, to write all the parts that make our app work with GNOME. Let's look at the code, and see how it's done!</p>
   </section>
 
@@ -93,13 +93,12 @@ const Webkit = imports.gi.WebKit;
 const HelloGNOME = new Lang.Class ({
     Name: 'Hello GNOME',
 ]]></code>
-    <p>This will look familiar to you if you've worked with object-oriented JavaScript before. That's right; our whole application is a class called <input>HelloGNOME</input>. And as you can see, we've given it a property that says what its name is.</p>
+    <p>This will look familiar to you if you've worked with object-oriented JavaScript before. That's right; our whole application is a class called HelloGNOME. And as you can see, we've given it a property that says what its name is.</p>
 
     <code mime="text/javascript"><![CDATA[
     // Create the application itself
     _init: function () {
-        this.application = new Gtk.Application ({
-            application_id: 'org.example.jshellognome' });
+        this.application = new Gtk.Application ();
 
         // Connect 'activate' and 'startup' signals to the callback functions
         this.application.connect('activate', Lang.bind(this, this._onActivate));
@@ -116,15 +115,15 @@ const HelloGNOME = new Lang.Class ({
         this._buildUI ();
     },
 ]]></code>
-    <p>Here's some code you will more or less copy-and-paste for every JavaScript application you build. It creates a new Application, and then binds its <input>activate</input> and <input>startup</input> signals to functions that make the window show itself and build its user interface, respectively.</p>
-    <p>What does that mean? Well, everything in a GNOME application sends out a signal when something important happens. A button might send out the <input>clicked</input> signal when you click on it, for instance. Our job is to connect the signals to functions which handle them, and make the things that we want to have happen occur. We do this using each object's <input>connect</input> method, which takes two arguments: The signal we want to handle, and the <input>Lang.bind</input> function, which we have to use to tell <input>connect</input> which function we want to have handle the signal.</p>
-    <p>In this case, we want <input>_onActivate</input> to handle the <input>activate</input> signal, and <input>_onStartup</input> to handle the <input>startup</input> signal. <input>_onActivate</input> just tells the window to present itself; so basically, whenever you <key>Alt</key> <key>Tab</key> to the application it appears, like you would expect it to. <input>_onStartup</input> calls <input>_buildUI</input>, which is the function that creates our user interface and is the next part that we will look at.</p>
-    <note style="tip"><p>When you copy and paste the above code for your own applications, be sure to change the <input>application_id</input> to a unique one each time.</p></note>
+    <p>Here's some code you will more or less copy-and-paste for every JavaScript application you build. It creates a new Application, and then binds its activate and startup signals to functions that make the window show itself and build its user interface, respectively.</p>
+    <p>What does that mean? Well, everything in a GNOME application sends out a signal when something important happens. A button might send out the clicked signal when you click on it, for instance. Our job is to connect the signals to functions which handle them, and make the things that we want to have happen occur. We do this using each object's connect method, which takes two arguments: The signal we want to handle, and the Lang.bind function, which we have to use to tell connect which function we want to have handle the signal.</p>
+    <p>In this case, we want _onActivate to handle the activate signal, and _onStartup to handle the startup signal. _onActivate just tells the window to present itself; so basically, whenever you <key>Alt</key> <key>Tab</key> to the application it appears, like you would expect it to. _onStartup calls _buildUI, which is the function that creates our user interface and is the next part that we will look at.</p>
+    <note style="tip"><p>When you copy and paste the above code for your own applications, be sure to change the name to a unique one each time.</p></note>
   </section>
 
   <section id="ui">
     <title>Designing our window's UI</title>
-    <p>In the <input>_buildUI</input> function, we're going to tell GNOME about our window and the things inside it, one at a time. After that, we're going to connect everything together and put it all on display.</p>
+    <p>In the _buildUI function, we're going to tell GNOME about our window and the things inside it, one at a time. After that, we're going to connect everything together and put it all on display.</p>
 
     <code mime="text/javascript"><![CDATA[
     // Build the application's UI
@@ -139,7 +138,7 @@ const HelloGNOME = new Lang.Class ({
             window_position: Gtk.WindowPosition.CENTER });
 ]]></code>
 
-    <p>The first object we create is an <input>ApplicationWindow</input>. It needs a title to go in the title bar, and its <input>application</input> property needs to be the application that we created, above. Beyond that, there are various ways of customizing how it looks, which the <link xref="GtkApplicationWindow.js">ApplicationWindow</link> reference page will go into more detail about. As you can see here, we gave it a default height and width (measured in pixels), and told GNOME we want our window to appear in the center of the screen.</p>
+    <p>The first object we create is an ApplicationWindow. It needs a title to go in the title bar, and its application property needs to be the application that we created, above. Beyond that, there are various ways of customizing how it looks, which the <link xref="GtkApplicationWindow.js">ApplicationWindow</link> reference page will go into more detail about. As you can see here, we gave it a default height and width (measured in pixels), and told GNOME we want our window to appear in the center of the screen.</p>
     <code mime="text/javascript"><![CDATA[
         // Create a webview to show the web app
         this._webView = new Webkit.WebView ();
@@ -148,8 +147,8 @@ const HelloGNOME = new Lang.Class ({
         this._webView.load_uri (GLib.filename_to_uri (GLib.get_current_dir() +
             "/hellognome.html", null));
 ]]></code>
-    <p>Remember how we imported Webkit right at the start? Here we're creating a new instance of a Webkit class called a <input>WebView</input>, which is more or less a browser window you can put inside of your app. After that, we then give it the URI that we want it to load when the application starts up.</p>
-    <p>We <em>could</em> just give it a web URI, like <link href="http://gnome.org";>http://gnome.org</link>. Instead, here we use a couple of GLib helper functions to tell the WebView where our <file>hellognome.html</file> file is. <input>GLib.get_current_dir</input> returns the directory that our app's running in, and <input>GLib.filename_to_uri</input> turns our file's path and filename into a URI that the WebView's <input>load_uri</input> function understands. (<input>filename_to_uri</input>'s second parameter should be <input>null</input> unless you know what it's used for and have a reason for changing it.)</p>
+    <p>Remember how we imported Webkit right at the start? Here we're creating a new instance of a Webkit class called a WebView, which is more or less a browser window you can put inside of your app. After that, we then give it the URI that we want it to load when the application starts up.</p>
+    <p>We <em>could</em> just give it a web URI, like <link href="http://gnome.org";>http://gnome.org</link>. Instead, here we use a couple of GLib helper functions to tell the WebView where our <file>hellognome.html</file> file is. GLib.get_current_dir returns the directory that our app's running in, and GLib.filename_to_uri turns our file's path and filename into a URI that the WebView's load_uri function understands. (filename_to_uri's second parameter should be null unless you know what it's used for and have a reason for changing it.)</p>
     <code mime="text/javascript"><![CDATA[
         // Put the webview into the window
         this._window.add (this._webView);
@@ -160,7 +159,7 @@ const HelloGNOME = new Lang.Class ({
 
 });
 ]]></code>
-    <p>Each window can hold one, and only one, widget. Normally, we'd use a container widget like a <link xref="grid.js">Grid</link> to put multiple widgets into, then use the window's <input>add</input> function to add the Grid to it. Here, we just need the WebView, so that's all we add to the window. After that, as the last part of the <input>_buildUI</input> function that creates our window, we tell the window to show itself and its contents.</p>
+    <p>Each window can hold one, and only one, widget. Normally, we'd use a container widget like a <link xref="grid.js">Grid</link> to put multiple widgets into, then use the window's add function to add the Grid to it. Here, we just need the WebView, so that's all we add to the window. After that, as the last part of the _buildUI function that creates our window, we tell the window to show itself and its contents.</p>
     <code mime="text/javascript"><![CDATA[
 // Run the application
 let app = new HelloGNOME ();
@@ -173,12 +172,12 @@ app.application.run (ARGV);
     <title>Running your GNOME application</title>
 
     <p>Now that we've created our first GNOME application, it's time to test it out! You don't need to compile your app or install any special software for this; GNOME has gjs built in, to let it run GNOME Shell. Just save <file>hellognome.html</file> and our actual application, <file>hellognome.js</file>, to a directory you can get to with the terminal. (They usually open onto your home directory, the one that's called by your username.) After that, open a terminal, go there, and type:</p>
-    <screen> <output style="prompt">$ </output><input>gjs hellognome.js</input> </screen>
+    <screen> <output style="prompt">$ </output>gjs hellognome.js </screen>
     <p>You should see more or less the same screenshot as before, with a button that you can click to make a short message appear.</p>
 
     <note style="tip">
         <p>You can use the terminal command</p>
-        <screen> <output style="prompt">$ </output><input>cd <var>(directory name)</var></input> </screen>
+        <screen> <output style="prompt">$ </output>cd <var>(directory name)</var> </screen>
         <p>to navigate between directories inside the Terminal, in order to get to where you saved the files. There is also an extension for Nautilus, GNOME's file manager, which lets you right-click anywhere inside it to open a terminal window right there. Check the app you use to install new software (like Add/Remove Programs or the Software Center) for it.</p>
     </note>
   </section>
@@ -187,7 +186,7 @@ app.application.run (ARGV);
     <title>What's next?</title>
 
     <p><link xref="02_welcome_to_the_grid.js">Continue on to the next tutorial</link> to learn how to build "native" GNOME applications that look and feel like the others, instead of a webview with HTML code inside. Or take a look at some <link xref="beginner.js#samples">code samples,</link> if you'd like to see example code for each Gtk widget.</p>
-    <p>Finally, if you want to just build GNOME applications using JavaScript libraries designed for the web, you can basically stop here and go do that! Take a look at the <link xref="scrolledwindow.js">ScrolledWindow</link> code sample if you'd like to see how to make a WebView widget that can scroll to show parts of a larger web page, and check out <link xref="beginner.js#tutorials">the later tutorials</link> if you'd like to see how to create a <input>.desktop</input> file for your application, which will let it appear in your desktop's Activities menu with all your other apps.</p>
+    <p>Finally, if you want to just build GNOME applications using JavaScript libraries designed for the web, you can basically stop here and go do that! Take a look at the <link xref="scrolledwindow.js">ScrolledWindow</link> code sample if you'd like to see how to make a WebView widget that can scroll to show parts of a larger web page, and check out <link xref="beginner.js#tutorials">the later tutorials</link> if you'd like to see how to create a .desktop file for your application, which will let it appear in your desktop's Activities menu with all your other apps.</p>
   </section>
 
   <section id="complete">
diff --git a/platform-demos/C/samples/hellognome.js b/platform-demos/C/samples/hellognome.js
index 5b454e3..396dca6 100644
--- a/platform-demos/C/samples/hellognome.js
+++ b/platform-demos/C/samples/hellognome.js
@@ -10,8 +10,7 @@ const HelloGNOME = new Lang.Class ({
 
     // Create the application itself
     _init: function () {
-        this.application = new Gtk.Application ({
-            application_id: 'org.example.jshellognome' });
+        this.application = new Gtk.Application ();
 
         // Connect 'activate' and 'startup' signals to the callback functions
         this.application.connect('activate', Lang.bind(this, this._onActivate));



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]