Development/Tutorials/K Hot New Stuff2 - Revision history

Neverendingo: Text replace - "" to ""

2011-06-29T20:52:36Z

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

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


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

				
				
				
				
			
			← Older revision
			Revision as of 20:44, 29 June 2011
			
Line 11:
Line 11:
  === First write a .knsrc file. ===   === First write a .knsrc file. ===
  A .knsrc file is just a file telling the library which options to use for a given application.  It also lists where providers can be found, where uploads should be sent, etc. Anyway, the format of the file is an ini file with one group:   A .knsrc file is just a file telling the library which options to use for a given application.  It also lists where providers can be found, where uploads should be sent, etc. Anyway, the format of the file is an ini file with one group:
− <code> + <syntaxhighlight lang="text">
  [KNewStuff2]   [KNewStuff2]
  ProvidersUrl=   ProvidersUrl=
Line 27:
Line 27:
    
  :One of the following is required to tell where downloads should go:   :One of the following is required to tell where downloads should go:
− <code> + <syntaxhighlight lang="text">
  TargetDir=   TargetDir=
  InstallPath=   InstallPath=
Line 41:
Line 41:
    
  :And the following values are currently read, though not used yet:   :And the following values are currently read, though not used yet:
− <code> + <syntaxhighlight lang="text">
  CustomName=   CustomName=
  CachePolicy=   CachePolicy=
Line 49:
Line 49:
  </code>   </code>
  :install the file using CMake install macro like this   :install the file using CMake install macro like this
− <code> + <syntaxhighlight lang="text">
  install( FILES yourdata.knsrc  DESTINATION  ${CONFIG_INSTALL_DIR} )   install( FILES yourdata.knsrc  DESTINATION  ${CONFIG_INSTALL_DIR} )
  </code>   </code>
  :at this point, you can test your knsrc file with khotnewstuff4 like so:   :at this point, you can test your knsrc file with khotnewstuff4 like so:
− <code> + <syntaxhighlight lang="text">
  khotnewstuff4 yourdata.knsrc   khotnewstuff4 yourdata.knsrc
  </code>   </code>
Line 63:
Line 63:
    
  : Option 1. Use the static call. KNewStuff::Engine has a static method     : Option 1. Use the static call. KNewStuff::Engine has a static method  
− <code> + <syntaxhighlight lang="text">
  static KNS::Entry::List download();   static KNS::Entry::List download();
  </code>   </code>
Line 69:
Line 69:
  :if you use this method, your knsrc file must have the same name as your KGlobal::activeComponent().componentName(), it will create an Engine object, initialize it with the knsrc file, and call downloadDialogModal, then before returning it will copy the list of modified (installed, uninstalled, etc.) entries.  Use is like this:   :if you use this method, your knsrc file must have the same name as your KGlobal::activeComponent().componentName(), it will create an Engine object, initialize it with the knsrc file, and call downloadDialogModal, then before returning it will copy the list of modified (installed, uninstalled, etc.) entries.  Use is like this:
    
− <code> + <syntaxhighlight lang="text">
       KNS::Entry::List entries = KNS::Engine::download();        KNS::Entry::List entries = KNS::Engine::download();
       // list of changed entries        // list of changed entries
Line 88:
Line 88:
  : Option 2. Allocate your own Engine object.  This method is more flexible, in that you can name your knsrc file anything you want, since you call Engine::init yourself.  You also don't have to worry about deleting the EntryList that is returned, since your Engine object owns it.  This method is done like so:   : Option 2. Allocate your own Engine object.  This method is more flexible, in that you can name your knsrc file anything you want, since you call Engine::init yourself.  You also don't have to worry about deleting the EntryList that is returned, since your Engine object owns it.  This method is done like so:
    
− <code> + <syntaxhighlight lang="text">
       KNS::Engine engine(0);        KNS::Engine engine(0);
       if (engine.init("wallpaper.knsrc")) {        if (engine.init("wallpaper.knsrc")) {



Josef: link to kns2 users list
2008-11-23T09:14:28Z
link to kns2 users list

				
				
				
				
			
			← Older revision
			Revision as of 09:14, 23 November 2008
			
Line 1:
Line 1:
  This tutorial informs about how to use Get Hot New Stuff collaborative data sharing features in your KDE application.   This tutorial informs about how to use Get Hot New Stuff collaborative data sharing features in your KDE application.
  Complementary to this tutorial, there is a [http://websvn.kde.org/*checkout*/trunk/KDE/kdelibs/knewstuff/doc/porting.txt porting guide] for KDE 3 developers and [http://websvn.kde.org/*checkout*/trunk/KDE/kdelibs/knewstuff/doc/tutorial.txt another tutorial] in SVN.   Complementary to this tutorial, there is a [http://websvn.kde.org/*checkout*/trunk/KDE/kdelibs/knewstuff/doc/porting.txt porting guide] for KDE 3 developers and [http://websvn.kde.org/*checkout*/trunk/KDE/kdelibs/knewstuff/doc/tutorial.txt another tutorial] in SVN.
  + The [[Projects/KNS2/Users|KNS2-enabled application list]] is also a good reference to find similar applications.
    
  == Terminology ==   == Terminology ==



Josef: link to other tutorials in SVN
2008-11-23T07:41:51Z
link to other tutorials in SVN

				
				
				
				
			
			← Older revision
			Revision as of 07:41, 23 November 2008
			
Line 1:
Line 1:
− The page that used to be here was all KDE3 specific information, so I figured it was about time to start a new one. + This tutorial informs about how to use Get Hot New Stuff collaborative data sharing features in your KDE application.
  + Complementary to this tutorial, there is a [http://websvn.kde.org/*checkout*/trunk/KDE/kdelibs/knewstuff/doc/porting.txt porting guide] for KDE 3 developers and [http://websvn.kde.org/*checkout*/trunk/KDE/kdelibs/knewstuff/doc/tutorial.txt another tutorial] in SVN.
    
  == Terminology ==   == Terminology ==



Jpwhiting: Add some implementation examples
2008-04-13T13:31:33Z
Add some implementation examples

				
				
				
				
			
			← Older revision
			Revision as of 13:31, 13 April 2008
			
Line 7:
Line 7:
  There are a many good examples for how to use khotnewstuff2 in the KDE-Edu module.  Look at their source code for examples if needed, but it's basically a 2-part process to get download into your app.   There are a many good examples for how to use khotnewstuff2 in the KDE-Edu module.  Look at their source code for examples if needed, but it's basically a 2-part process to get download into your app.
    
− === 1. First write a .knsrc file. === + === First write a .knsrc file. ===
  A .knsrc file is just a file telling the library which options to use for a given application.  It also lists where providers can be found, where uploads should be sent, etc. Anyway, the format of the file is an ini file with one group:   A .knsrc file is just a file telling the library which options to use for a given application.  It also lists where providers can be found, where uploads should be sent, etc. Anyway, the format of the file is an ini file with one group:
  <code>   <code>
Line 56:
Line 56:
  :it should show you a download dialog of the data available on your provider(s).   :it should show you a download dialog of the data available on your provider(s).
    
− === 2. Make your application launch the KNS ui with your knsrc file. === + === Make your application launch the KNS ui with your knsrc file. ===
  +  
  + :There are many examples of using KNS in code, kde-edu apps, kdegames apps, plasma, some kcm modules, etc.  Basically there are two options at this time for invoking the download dialog.
  +  
  + : Option 1. Use the static call. KNewStuff::Engine has a static method 
  + <code>
  + static KNS::Entry::List download();
  + </code>
  +  
  + :if you use this method, your knsrc file must have the same name as your KGlobal::activeComponent().componentName(), it will create an Engine object, initialize it with the knsrc file, and call downloadDialogModal, then before returning it will copy the list of modified (installed, uninstalled, etc.) entries.  Use is like this:
  +  
  + <code>
  +     KNS::Entry::List entries = KNS::Engine::download();
  +     // list of changed entries
  +     foreach(KNS::Entry* entry, entries) {
  +         // care only about installed ones
  +         if (entry->status() == KNS::Entry::Installed) {
  +             // do something with the installed entries
  +             }
  +         }
  +     }
  +     qDeleteAll(entries);
  + </code>
  + :Taken from kdeedu/parley/src/parleydocument.cpp
  +  
  + ::'''NOTE''': Since the Ently::List is a copy of entries from the engine that has now been deleted, you are responsible for cleanup of the allocated Entry(s).
  +  
  +  
  + : Option 2. Allocate your own Engine object.  This method is more flexible, in that you can name your knsrc file anything you want, since you call Engine::init yourself.  You also don't have to worry about deleting the EntryList that is returned, since your Engine object owns it.  This method is done like so:
  +  
  + <code>
  +     KNS::Engine engine(0);
  +     if (engine.init("wallpaper.knsrc")) {
  +         KNS::Entry::List entries = engine.downloadDialogModal(this);
  +  
  +         if (entries.size() > 0) {
  + 	    // do something with the modified entries here if you want
  +  
  +             // such as rescaning your data folder or whatnot
  +             m_model->reload();
  +         }
  +     }
  + </code>
  + :Taken from plasma/containments/desktop/backgrounddialog.cpp



Tampakrap: formatting update
2008-04-06T17:43:41Z
formatting update

				
				
				
				
			
			← Older revision
			Revision as of 17:43, 6 April 2008
			
Line 7:
Line 7:
  There are a many good examples for how to use khotnewstuff2 in the KDE-Edu module.  Look at their source code for examples if needed, but it's basically a 2-part process to get download into your app.   There are a many good examples for how to use khotnewstuff2 in the KDE-Edu module.  Look at their source code for examples if needed, but it's basically a 2-part process to get download into your app.
    
− :1. First write a .knsrc file.  A .knsrc file is just a file telling the library which options to use for a given application.  It also lists where providers can be found, where uploads should be sent, etc. Anyway, the format of the file is an ini file with one group: + === 1. First write a .knsrc file. ===
  + A .knsrc file is just a file telling the library which options to use for a given application.  It also lists where providers can be found, where uploads should be sent, etc. Anyway, the format of the file is an ini file with one group:
  <code>   <code>
  [KNewStuff2]   [KNewStuff2]
Line 15:
Line 16:
  </code>   </code>
    
− :'''NOTE''': InstallationCommand is optional, and if included will be invoked after each item is downloaded. + ::'''NOTE''': InstallationCommand is optional, and if included will be invoked after each item is downloaded.
− :'''NOTE''': Uncompress is optional, and if included will try to uncompress all downloads into the target folder according to the mime-type of the file. + ::'''NOTE''': Uncompress is optional, and if included will try to uncompress all downloads into the target folder according to the mime-type of the file.
− * Uncompress possible values as of r794016 are + :* Uncompress possible values as of r794016 are
− * "always" - always attempt to uncompress (old values of "true" are seen as "always" + :* "always" - always attempt to uncompress (old values of "true" are seen as "always"
− * "archive" - uncompress if it's an archive but copy otherwise + :* "archive" - uncompress if it's an archive but copy otherwise
− * "never" - (default) never attempt to uncompress + :* "never" - (default) never attempt to uncompress
    
    
− One of the following is required to tell where downloads should go: + :One of the following is required to tell where downloads should go:
  <code>   <code>
  TargetDir=   TargetDir=
Line 31:
Line 32:
  </code>   </code>
    
− * TargetDir installs to KStandardDirs::locateLocal("data") + TargetDir + "/" + :* TargetDir installs to KStandardDirs::locateLocal("data") + TargetDir + "/"
− * StandardResource installs to KStandardDirs::locateLocal(StandardResource) + :* StandardResource installs to KStandardDirs::locateLocal(StandardResource)
− * InstallPath installs to QDir::home().path() + "/" + InstallPath + :* InstallPath installs to QDir::home().path() + "/" + InstallPath
− * AbsoluteInstallPath installs to AbsoluteInstallPath + "/" + :* AbsoluteInstallPath installs to AbsoluteInstallPath + "/"
− :'''NOTE''': AbsoluteInstallPath is not portable (/boot/grub is probably not a valid path except on linux), so should not be used in anything that is meant to run on all our platforms. + ::'''NOTE''': AbsoluteInstallPath is not portable (/boot/grub is probably not a valid path except on linux), so should not be used in anything that is meant to run on all our platforms.
    
− And the following values are currently read, though not used yet: + :And the following values are currently read, though not used yet:
  <code>   <code>
  CustomName=   CustomName=
Line 45:
Line 46:
  Scope=   Scope=
  </code>   </code>
− install the file using CMake install macro like this + :install the file using CMake install macro like this
  <code>   <code>
  install( FILES yourdata.knsrc  DESTINATION  ${CONFIG_INSTALL_DIR} )   install( FILES yourdata.knsrc  DESTINATION  ${CONFIG_INSTALL_DIR} )
  </code>   </code>
− at this point, you can test your knsrc file with khotnewstuff4 like so: + :at this point, you can test your knsrc file with khotnewstuff4 like so:
  <code>   <code>
  khotnewstuff4 yourdata.knsrc   khotnewstuff4 yourdata.knsrc
  </code>   </code>
− it should show you a download dialog of the data available on your provider(s). + :it should show you a download dialog of the data available on your provider(s).
    
− :2. Make your application launch the KNS ui with your knsrc file. + === 2. Make your application launch the KNS ui with your knsrc file. ===



Jpwhiting: add Uncompress details
2008-04-06T02:20:42Z
add Uncompress details

				
				
				
				
			
			← Older revision
			Revision as of 02:20, 6 April 2008
			
Line 17:
Line 17:
  :'''NOTE''': InstallationCommand is optional, and if included will be invoked after each item is downloaded.   :'''NOTE''': InstallationCommand is optional, and if included will be invoked after each item is downloaded.
  :'''NOTE''': Uncompress is optional, and if included will try to uncompress all downloads into the target folder according to the mime-type of the file.   :'''NOTE''': Uncompress is optional, and if included will try to uncompress all downloads into the target folder according to the mime-type of the file.
  + * Uncompress possible values as of r794016 are
  + * "always" - always attempt to uncompress (old values of "true" are seen as "always"
  + * "archive" - uncompress if it's an archive but copy otherwise
  + * "never" - (default) never attempt to uncompress
    
− One of the following to tell where downloads should go: +  
  + One of the following is required to tell where downloads should go:
  <code>   <code>
  TargetDir=   TargetDir=



Jpwhiting: add absoluteInstallPath to the tutorial
2008-03-31T12:24:11Z
add absoluteInstallPath to the tutorial

				
				
				
				
			
			← Older revision
			Revision as of 12:24, 31 March 2008
			
Line 23:
Line 23:
  InstallPath=   InstallPath=
  StandardResource=   StandardResource=
  + AbsoluteInstallPath=
  </code>   </code>
    
Line 28:
Line 29:
  * StandardResource installs to KStandardDirs::locateLocal(StandardResource)   * StandardResource installs to KStandardDirs::locateLocal(StandardResource)
  * InstallPath installs to QDir::home().path() + "/" + InstallPath   * InstallPath installs to QDir::home().path() + "/" + InstallPath
  + * AbsoluteInstallPath installs to AbsoluteInstallPath + "/"
  + :'''NOTE''': AbsoluteInstallPath is not portable (/boot/grub is probably not a valid path except on linux), so should not be used in anything that is meant to run on all our platforms.
    
  And the following values are currently read, though not used yet:   And the following values are currently read, though not used yet:



Jpwhiting: formatting change
2008-03-30T17:15:10Z
formatting change

				
				
				
				
			
			← Older revision
			Revision as of 17:15, 30 March 2008
			
Line 37:
Line 37:
  Scope=   Scope=
  </code>   </code>
−  
  install the file using CMake install macro like this   install the file using CMake install macro like this
−  
  <code>   <code>
  install( FILES yourdata.knsrc  DESTINATION  ${CONFIG_INSTALL_DIR} )   install( FILES yourdata.knsrc  DESTINATION  ${CONFIG_INSTALL_DIR} )
  </code>   </code>
−  
  at this point, you can test your knsrc file with khotnewstuff4 like so:   at this point, you can test your knsrc file with khotnewstuff4 like so:
−  
  <code>   <code>
  khotnewstuff4 yourdata.knsrc   khotnewstuff4 yourdata.knsrc
  </code>   </code>
−  
  it should show you a download dialog of the data available on your provider(s).   it should show you a download dialog of the data available on your provider(s).
    
  :2. Make your application launch the KNS ui with your knsrc file.   :2. Make your application launch the KNS ui with your knsrc file.



Jpwhiting: added desciption of install location configs
2008-03-30T17:07:23Z
added desciption of install location configs

				
				
				
				
			
			← Older revision
			Revision as of 17:07, 30 March 2008
			
Line 25:
Line 25:
  </code>   </code>
    
− TargetDir installs to KStandardDirs::locateLocal("data") + TargetDir + "/" + * TargetDir installs to KStandardDirs::locateLocal("data") + TargetDir + "/"
−   + * StandardResource installs to KStandardDirs::locateLocal(StandardResource)
− StandardResource installs to KStandardDirs::locateLocal(StandardResource) + * InstallPath installs to QDir::home().path() + "/" + InstallPath
−   + 
− InstallPath installs to QDir::home().path() + "/" + InstallPath + 
    
  And the following values are currently read, though not used yet:   And the following values are currently read, though not used yet:

← Older revision		Revision as of 07:41, 23 November 2008
Line 1:		Line 1:
−	~~The page that used to be here was all KDE3 specific information, so I figured it was~~ about ~~time~~ to ~~start~~ a ~~new one~~.	+	This tutorial informs about how to use Get Hot New Stuff collaborative data sharing features in your KDE application.
		+	Complementary to this tutorial, there is a [http://websvn.kde.org/checkout/trunk/KDE/kdelibs/knewstuff/doc/porting.txt porting guide] for KDE 3 developers and [http://websvn.kde.org/checkout/trunk/KDE/kdelibs/knewstuff/doc/tutorial.txt another tutorial] in SVN.

	== Terminology ==		== Terminology ==