Development/Tutorials/Plasma/Ruby/GettingStarted - Revision history

Neverendingo: Text replace - "" to ""

2011-06-29T20:54:23Z

Text replace - "</code>" to "</syntaxhighlight>"

Neverendingo: Text replace - "`" to ""`


2011-06-29T20:45:25Z
Text replace - "<code>" to "<syntaxhighlight lang="text">"

				
				
				
				
			
			← Older revision
			Revision as of 20:45, 29 June 2011
			
Line 122:
Line 122:
  </pre>   </pre>
  Then make sure that all "ruby kde" depdendencies are installed. In ubuntu for example you should have the next package:     Then make sure that all "ruby kde" depdendencies are installed. In ubuntu for example you should have the next package:  
− <code> + <syntaxhighlight lang="text">
  korundum4     korundum4  
  </code>   </code>
    
  For additional help see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted#Troubleshooting here]   For additional help see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted#Troubleshooting here]



Nicolas17: update to new syntaxhighlighter
2011-06-29T19:38:33Z
update to new syntaxhighlighter

				
				
				
				
			
			← Older revision
			Revision as of 19:38, 29 June 2011
			
Line 8:
Line 8:
    
  The first step for any software project is to set up your project's directory on disk. For this tutorial we are going to create a very simple "hello-ruby" applet. Create a directory on somewhere called <tt>hello-ruby</tt> which in turn contains a <tt>contents</tt> directory which then contains a <tt>code</tt> directory. This command below will do all this.   The first step for any software project is to set up your project's directory on disk. For this tutorial we are going to create a very simple "hello-ruby" applet. Create a directory on somewhere called <tt>hello-ruby</tt> which in turn contains a <tt>contents</tt> directory which then contains a <tt>code</tt> directory. This command below will do all this.
− <code bash> + <syntaxhighlight lang="bash">
  mkdir -p hello-ruby/contents/code   mkdir -p hello-ruby/contents/code
− </code> + </syntaxhighlight>
  This creates a simple directory structure which also matches the package structure expect by the <tt>plasmapkg</tt> command. More on this later.   This creates a simple directory structure which also matches the package structure expect by the <tt>plasmapkg</tt> command. More on this later.
    
Line 17:
Line 17:
  In the <tt>hello-ruby</tt> directory create a file called <tt>metadata.desktop</tt> and open it in your text editor. Copy the following code into <tt>metadata.desktop</tt>.   In the <tt>hello-ruby</tt> directory create a file called <tt>metadata.desktop</tt> and open it in your text editor. Copy the following code into <tt>metadata.desktop</tt>.
    
− <code ini> + <syntaxhighlight lang="ini">
  [Desktop Entry]   [Desktop Entry]
  Encoding=UTF-8   Encoding=UTF-8
Line 36:
Line 36:
  X-KDE-PluginInfo-License=GPL   X-KDE-PluginInfo-License=GPL
  X-KDE-PluginInfo-EnabledByDefault=true   X-KDE-PluginInfo-EnabledByDefault=true
− </code> + </syntaxhighlight>
    
  This <tt>metadata.desktop</tt> file list important information needed by Plasma to load the applet, and also information about what the applet is and who created it. The <tt>Name</tt> field lists the name of the applet. This field can also be listed multiple times as different translations. Here I've just given a Dutch translation of the name. The <tt>[nl]</tt> indicates the language of the field.   This <tt>metadata.desktop</tt> file list important information needed by Plasma to load the applet, and also information about what the applet is and who created it. The <tt>Name</tt> field lists the name of the applet. This field can also be listed multiple times as different translations. Here I've just given a Dutch translation of the name. The <tt>[nl]</tt> indicates the language of the field.
Line 52:
Line 52:
  Create a file in the <tt>contents/code</tt> directory called <tt>main.rb</tt>, open it up in your text editor and put this code in it and save it.   Create a file in the <tt>contents/code</tt> directory called <tt>main.rb</tt>, open it up in your text editor and put this code in it and save it.
    
− <code ruby> + <syntaxhighlight lang="ruby">
  # <Copyright and license information goes here.>   # <Copyright and license information goes here.>
  require 'plasma_applet'   require 'plasma_applet'
Line 76:
Line 76:
     end      end
  end   end
− </code> + </syntaxhighlight>
    
  This is basically the simplest applet which actually does something. The code starts out with the usual copyright notice and license information which I've actually left out for now.   This is basically the simplest applet which actually does something. The code starts out with the usual copyright notice and license information which I've actually left out for now.
Line 90:
Line 90:
    
  Plasma applets can be packaged in zip files and installed using the <tt>plasmapkg</tt> command line tool. The directory structure which we have used for our project matches that need in the zip file. All we have to do is zip it update. Run the following command from inside the hello-ruby directory.   Plasma applets can be packaged in zip files and installed using the <tt>plasmapkg</tt> command line tool. The directory structure which we have used for our project matches that need in the zip file. All we have to do is zip it update. Run the following command from inside the hello-ruby directory.
− <code bash> + <syntaxhighlight lang="bash">
  zip -r ../hello-ruby.zip .   zip -r ../hello-ruby.zip .
− </code> + </syntaxhighlight>
  This will create the hello-ruby.zip file in the directory just above the hello-ruby directory. Go to this directory in the shell and run this <tt>plasmapkg</tt> command to install our little hello-ruby applet.   This will create the hello-ruby.zip file in the directory just above the hello-ruby directory. Go to this directory in the shell and run this <tt>plasmapkg</tt> command to install our little hello-ruby applet.
− <code bash> + <syntaxhighlight lang="bash">
  plasmapkg -i hello-ruby.zip   plasmapkg -i hello-ruby.zip
− </code> + </syntaxhighlight>
  This installs the applet into your home directory. Now we can run it. When developing applets it is more convenient to use the <tt>plasmoidviewer</tt>. This is a little utility which displays an applet in a window instead of you having to use your desktop. This command below will run our applet.   This installs the applet into your home directory. Now we can run it. When developing applets it is more convenient to use the <tt>plasmoidviewer</tt>. This is a little utility which displays an applet in a window instead of you having to use your desktop. This command below will run our applet.
− <code bash> + <syntaxhighlight lang="bash">
  plasmoidviewer hello-ruby   plasmoidviewer hello-ruby
− </code> + </syntaxhighlight>
  You should now be able to see the fruits of your labor.   You should now be able to see the fruits of your labor.
    
  To uninstall our applet we use <tt>plasmapkg</tt> again with its -r option.   To uninstall our applet we use <tt>plasmapkg</tt> again with its -r option.
− <code bash> + <syntaxhighlight lang="bash">
  plasmapkg -r hello-ruby   plasmapkg -r hello-ruby
− </code> + </syntaxhighlight>
    
  == Conclusion ==   == Conclusion ==
Line 117:
Line 117:
    
  If you have this error message instead of plasmoid:   If you have this error message instead of plasmoid:
− <code> + <pre>
  This object could not be created for the following reason:   This object could not be created for the following reason:
      Could not create a ruby-script ScriptEngine for the Hello Ruby widget.       Could not create a ruby-script ScriptEngine for the Hello Ruby widget.
− </code> + </pre>
  Then make sure that all "ruby kde" depdendencies are installed. In ubuntu for example you should have the next package:     Then make sure that all "ruby kde" depdendencies are installed. In ubuntu for example you should have the next package:  
  <code>   <code>



Outolumo: /* Troubleshooting */ fix: In ubuntu the package is korundum4, not libkorondum4-ruby1.8
2010-08-04T12:54:29Z
‎Troubleshooting:  fix: In ubuntu the package is korundum4, not libkorondum4-ruby1.8

				
				
				
				
			
			← Older revision
			Revision as of 12:54, 4 August 2010
			
Line 123:
Line 123:
  Then make sure that all "ruby kde" depdendencies are installed. In ubuntu for example you should have the next package:     Then make sure that all "ruby kde" depdendencies are installed. In ubuntu for example you should have the next package:  
  <code>   <code>
− libkorundum4-ruby1.8 + korundum4 
  </code>   </code>
    
  For additional help see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted#Troubleshooting here]   For additional help see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted#Troubleshooting here]



De lorian at 20:27, 26 August 2009
2009-08-26T20:27:55Z


				
				
				
				
			
			← Older revision
			Revision as of 20:27, 26 August 2009
			
Line 121:
Line 121:
      Could not create a ruby-script ScriptEngine for the Hello Ruby widget.       Could not create a ruby-script ScriptEngine for the Hello Ruby widget.
  </code>   </code>
− Then make sure that all "ruby kde" depdendencies are installed. In ubuntu for example you should have the next packages:   + Then make sure that all "ruby kde" depdendencies are installed. In ubuntu for example you should have the next package:  
  <code>   <code>
  libkorundum4-ruby1.8     libkorundum4-ruby1.8  
− libkrossruby  
  </code>   </code>
    
  For additional help see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted#Troubleshooting here]   For additional help see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted#Troubleshooting here]



Tampakrap: Troubleshooting
2009-08-25T16:03:11Z
Troubleshooting

				
				
				
				
			
			← Older revision
			Revision as of 16:03, 25 August 2009
			
Line 115:
Line 115:
    
  == Troubleshooting ==   == Troubleshooting ==
− see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted#Troubleshooting here] +  
  + If you have this error message instead of plasmoid:
  + <code>
  + This object could not be created for the following reason:
  +    Could not create a ruby-script ScriptEngine for the Hello Ruby widget.
  + </code>
  + Then make sure that all "ruby kde" depdendencies are installed. In ubuntu for example you should have the next packages: 
  + <code>
  + libkorundum4-ruby1.8 
  + libkrossruby
  + </code>
  +  
  + For additional help see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted#Troubleshooting here]



Tampakrap: Add link to troubleshooting section in python-tutorial
2009-04-23T11:52:03Z
Add link to troubleshooting section in python-tutorial

				
				
				
				
			
			← Older revision
			Revision as of 11:52, 23 April 2009
			
Line 113:
Line 113:
    
  In the next tutorial we explain how to use Plasma's specialized widgets in your applet instead of manually implementing the <tt>paintInterface</tt> method. Find out how in the [[../Using widgets|Using widgets tutorial]].   In the next tutorial we explain how to use Plasma's specialized widgets in your applet instead of manually implementing the <tt>paintInterface</tt> method. Find out how in the [[../Using widgets|Using widgets tutorial]].
  + 
  + == Troubleshooting ==
  + see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted#Troubleshooting here]



Nielsslot: Add a link to the next tutorial
2009-02-09T20:56:36Z
Add a link to the next tutorial

				
				
				
				
			
			← Older revision
			Revision as of 20:56, 9 February 2009
			
Line 112:
Line 112:
  This tutorial covers very basics of developing Plasma applets using Ruby. Most of the material discussed here is boring but important "boilerplate" stuff which stays mostly the same between every applet project. In future tutorials we can move on to move exciting things than just displaying a single line of static text.   This tutorial covers very basics of developing Plasma applets using Ruby. Most of the material discussed here is boring but important "boilerplate" stuff which stays mostly the same between every applet project. In future tutorials we can move on to move exciting things than just displaying a single line of static text.
    
− In the next tutorial we explain how to use Plasma's specialized widgets in your applet instead of manually implementing the <tt>paintInterface</tt> method. + In the next tutorial we explain how to use Plasma's specialized widgets in your applet instead of manually implementing the <tt>paintInterface</tt> method. Find out how in the [[../Using widgets|Using widgets tutorial]].



Tampakrap: Fixed a couple of errors. The class should be called 'HelloRuby' to match the 'hello-ruby' applet name, and X-PLasma-API in the .desktop file should be 'ruby-script'
2009-02-04T16:49:12Z
Fixed a couple of errors. The class should be called 'HelloRuby' to match the 'hello-ruby' applet name, and X-PLasma-API in the .desktop file should be 'ruby-script'

				
				
				
				
			
			← Older revision
			Revision as of 16:49, 4 February 2009
			
Line 25:
Line 25:
  ServiceTypes=Plasma/Applet   ServiceTypes=Plasma/Applet
  Icon=chronometer   Icon=chronometer
− X-Plasma-API=ruby + X-Plasma-API=ruby-script
  X-Plasma-MainScript=code/main.rb   X-Plasma-MainScript=code/main.rb
  X-KDE-PluginInfo-Author=Simon Edwards   X-KDE-PluginInfo-Author=Simon Edwards
Line 56:
Line 56:
  require 'plasma_applet'   require 'plasma_applet'
    
− module RubyStart + module HelloRuby
     class Main < PlasmaScripting::Applet      class Main < PlasmaScripting::Applet
       def initialize parent        def initialize parent





Nielsslot: Change warning text
2009-01-25T12:58:47Z
Change warning text

				
				
				
				
			
			← Older revision
			Revision as of 12:58, 25 January 2009
			
Line 1:
Line 1:
− Warning: This is a plain 'port' of the Getting Started article on Python and Plasma. I have changed the text where necessary for Ruby, and of course changed the example. Some things however might be incorrect. For the Python Tutorial see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted here]. + This is a 'translation' of the Getting Started article on Python and Plasma. For the Python Tutorial see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted here].
    
  == Abstract ==   == Abstract ==

← Older revision		Revision as of 16:03, 25 August 2009
Line 115:		Line 115:

	== Troubleshooting ==		== Troubleshooting ==
−	see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted#Troubleshooting here]	+
		+	If you have this error message instead of plasmoid:
		+	<code>
		+	This object could not be created for the following reason:
		+	Could not create a ruby-script ScriptEngine for the Hello Ruby widget.
		+	</code>
		+	Then make sure that all "ruby kde" depdendencies are installed. In ubuntu for example you should have the next packages:
		+	<code>
		+	libkorundum4-ruby1.8
		+	libkrossruby
		+	</code>
		+
		+	For additional help see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted#Troubleshooting here]

← Older revision		Revision as of 11:52, 23 April 2009
Line 113:		Line 113:

	In the next tutorial we explain how to use Plasma's specialized widgets in your applet instead of manually implementing the <tt>paintInterface</tt> method. Find out how in the [[../Using widgets\|Using widgets tutorial]].		In the next tutorial we explain how to use Plasma's specialized widgets in your applet instead of manually implementing the <tt>paintInterface</tt> method. Find out how in the [[../Using widgets\|Using widgets tutorial]].
		+
		+	== Troubleshooting ==
		+	see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted#Troubleshooting here]

← Older revision		Revision as of 20:56, 9 February 2009
Line 112:		Line 112:
	This tutorial covers very basics of developing Plasma applets using Ruby. Most of the material discussed here is boring but important "boilerplate" stuff which stays mostly the same between every applet project. In future tutorials we can move on to move exciting things than just displaying a single line of static text.		This tutorial covers very basics of developing Plasma applets using Ruby. Most of the material discussed here is boring but important "boilerplate" stuff which stays mostly the same between every applet project. In future tutorials we can move on to move exciting things than just displaying a single line of static text.

−	In the next tutorial we explain how to use Plasma's specialized widgets in your applet instead of manually implementing the <tt>paintInterface</tt> method.	+	In the next tutorial we explain how to use Plasma's specialized widgets in your applet instead of manually implementing the <tt>paintInterface</tt> method. Find out how in the [[../Using widgets\|Using widgets tutorial]].

← Older revision		Revision as of 12:58, 25 January 2009
Line 1:		Line 1:
−	~~Warning:~~ This is a ~~plain~~ '~~port~~' of the Getting Started article on Python and Plasma~~. I have changed the text where necessary for Ruby, and of course changed the example. Some things however might be incorrect~~. For the Python Tutorial see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted here].	+	This is a 'translation' of the Getting Started article on Python and Plasma. For the Python Tutorial see [http://techbase.kde.org/Development/Tutorials/Plasma/Python/GettingStarted here].

	== Abstract ==		== Abstract ==