Projects/Silk/Selkie - Revision history

Nicolas17: testing (sorry for doing it on the live page...)

2011-10-09T23:36:09Z

testing (sorry for doing it on the live page...)

Nicolas17: cleanup paragraphs, removing unneeded blank lines between the,

2011-10-09T23:34:32Z

cleanup paragraphs, removing unneeded blank lines between the,

Sebas: /* Where is the code? */

2011-01-19T11:28:30Z

‎Where is the code?

Unormal: SPAM: Undo revision 51109 by Larrsmith07 (Talk)

2010-05-11T10:29:46Z

SPAM: Undo revision 51109 by Larrsmith07 (Talk)

Larrsmith07 at 09:21, 11 May 2010

2010-05-11T09:21:28Z

Sebas: fixes

2009-09-09T20:20:50Z

fixes

Sebas: local pages

2009-09-09T20:18:22Z

local pages

Sebas at 20:08, 9 September 2009

2009-09-09T20:08:25Z

Sebas: /* What? */

2009-09-09T18:51:15Z

‎What?

Sebas: /* Status / TODO */

2009-09-09T18:42:44Z

‎Status / TODO

← Older revision		Revision as of 23:36, 9 October 2011
Line 1:		Line 1:
		+	{{DISPLAYTITLE:projects/silk/SeLkIe}}
	= Selkie - Standalone Web Application =		= Selkie - Standalone Web Application =
	== What is Selkie? ==		== What is Selkie? ==

@@ Line 1: / Line 1: @@
 = Selkie - Standalone Web Application =
 == What is Selkie? ==
-<p>
 Selkie is a standalone web application shell. With Selkie, you can use Web Applications as first-class citizens on your desktop. Selkie WebApps appear as full applications in your desktop. Entries of these web applications are added to the start menu, then can be found in KRunner on the KDE desktop, they appear as their own entry in the taskbar and window-switching machinery.
-</p><p>
 Selkie allows you to create customized web application. You can add actions to Selkie applications that can be triggered from the toolbar, or on loading webpages. With these actions, you can "inject" Javascript and run them in the context of the website. This allows you to manipulate the contents and behavior of your web application at runtime. Selkie plugins do not contain any "compiled" or native code. The plugins are simple .desktop files that contain the information about a specific webapp. Likewise, actions are .desktop Files as well. They either contain a JavaScript one-liner or point to a Javascript file which is then executed "inside" your web application. From these scripts, you can also access functions Silk offers you, such as triggering notifications on the desktop, or logging to the console.
-</p><p>
 Selkie is built using WebKit and makes use of KDE's plugin system and Toolbar / Action system. Selkie can load and execute greasemonkey scripts as well, so there are literally hundreds of actions available.
-</p>
 == How does Selkie work? ==
@@ Line 18: / Line 18: @@
 == Is it stable? ==
 Not at all. It eats kittens and babies. Selkie is not feature-complete, nor widely tested either, it is in a proof-of-concept stage. The code is currently in a "proof-of-concept" stage, but not feature-complete. You can already create WebApps and actions for them, filtering based on URLs and wildcards has been implemented.
 == Creating Web Applications ==
@@ Line 80: / Line 78: @@
 === Defining Actions ===
 Actions apply to a specific site, and within this site to a URL. Actions can be shown for some URLs and hidden for others. An action can be triggered by the user, and will execute a piece of JavaScript in the website's context. This way, you can "inject" JavaScript into the running website, for example to hide certain elements or trigger functions. to invoke an action in the website's own JavaScript API.
 The webapplication, after starting the service-specific plugin, scans for plugins of the type Silk/WebApp/Action, and creates Actions from the .desktop files. An action plugin can provide a JavaScript one-liner to run (window.location = 'http://that.domain/some_page' to jump to a location). It's also possible to provide a JavaScript file for more complex things. An example for this is the togglesidebar.js script in the silk service directory.
 <pre>

@@ Line 14: / Line 14: @@
 == Where is the code? ==
 Selkie is developed inside the Project Silk git repository on Gitorious.org. You need a recent Qt (>=4.5) and KDE development tools and headers installed (4.3.x should do).
-* [[http://gitorious.org/project-silk|Project Silk on Gitorious]]
+*[[ssh://git@git.kde.org/silk|Project Silk on Gitorious]]
 == Is it stable? ==

← Older revision		Revision as of 10:29, 11 May 2010
Line 152:		Line 152:
	* actions should have a "persistant" flag to execute them on every new page load, within a context		* actions should have a "persistant" flag to execute them on every new page load, within a context
	* some way of automating the creation of those things (apps + actions) (webappeditor, in progress)		* some way of automating the creation of those things (apps + actions) (webappeditor, in progress)
−
−	~~==Related Links:==~~
−
−	~~[http://www.lindaolsson.com/'''palm beach homes''']~~

← Older revision		Revision as of 09:21, 11 May 2010
Line 152:		Line 152:
	* actions should have a "persistant" flag to execute them on every new page load, within a context		* actions should have a "persistant" flag to execute them on every new page load, within a context
	* some way of automating the creation of those things (apps + actions) (webappeditor, in progress)		* some way of automating the creation of those things (apps + actions) (webappeditor, in progress)
		+
		+	==Related Links:==
		+
		+	[http://www.lindaolsson.com/'''palm beach homes''']

@@ Line 121: / Line 121: @@
 </pre>
 You can also create local applications with Silk, by just providing a bunch of HTML files, image data and a start location. For pure client side apps, this can be enough to create simply local standalone webapps.
 Install these files like this:
@@ Line 140: / Line 144: @@
 In the Selkie service directory, you can find more examples how to build custom web applications. Have a look at "selkie test" for a demo.
 = Status / TODO =

@@ Line 25: / Line 25: @@
 === Setting up the Selkie Web Application ===
 WebApps consist of configuration settings and Actions. The settings for a webapp are read from a .desktop file.
@@ Line 104: / Line 102: @@
 ** You need one silk-webapp-myplugin-myaction.desktop file per action, containing name, icon and options for triggering and enabling the action
 ** Possibly a script if you're using the X-Silk-ScriptFile option
-** or a one-line in the form of X-Silk-Script=window.location = 'http://mail.google.com/mail/?view=cm&fs=1&tf=1'
+** or a one-line in the form of <pre>X-Silk-Script=window.location = 'http://mail.google.com/mail/?view=cm&fs=1&tf=1'</pre> (if both options are given, the one-liner will be preferred, the file will be ignored). Note: this should be changed to run the one-liner after the script has been included.
-      (if both options are given, the one-liner will be preferred, the file will be ignored)
 ** every files needs to be installed via CMakeLists.txt
@@ Line 112: / Line 109: @@
 In CMakeLists.txt, you need to add the .desktop files.
 <pre>
-install( FILES selkie-silk.desktop DESTINATION ${XDG_APPS_INSTALL_DIR} )
+install( FILES selkie-test.desktop DESTINATION ${XDG_APPS_INSTALL_DIR} )
-install( FILES silk-webapp-silk.desktop DESTINATION ${SERVICES_INSTALL_DIR})
+install( FILES silk-webapp-test.desktop DESTINATION ${SERVICES_INSTALL_DIR})
-install( FILES silk-webapp-silk-commitlog.desktop DESTINATION ${SERVICES_INSTALL_DIR})
+install( FILES silk-webapp-test-toolbar.desktop DESTINATION ${SERVICES_INSTALL_DIR})
-install( FILES silk-webapp-silk-sourcetree.desktop DESTINATION ${SERVICES_INSTALL_DIR})
+install(FILES toolbaraction.js DESTINATION ${DATA_INSTALL_DIR}/silk-webapp/test/)
-install( FILES silk-webapp-silk-sidebar.desktop DESTINATION ${SERVICES_INSTALL_DIR})
+install( FILES silk-webapp-test-trigger.desktop DESTINATION ${SERVICES_INSTALL_DIR})
-install(FILES togglesidebar.js DESTINATION ${DATA_INSTALL_DIR}/silk-webapp/silk/)
+install(FILES triggeraction.js DESTINATION ${DATA_INSTALL_DIR}/silk-webapp/test/)
-silk-webapp-silk-sidebar.desktop as example:
 </pre>
 An action will have 1 entry for the desktop file, and one optionally for a .js file, if you're using the ScriptFile option. Make sure you install the .desktop files into their respective locations: the apps directory for the launcher, the service directory for your site plugin, and your additional files into the data install dir. Every plugin should install into a subdirectory called /silk-webapp/myplugin -- if you don't install it there, it won't be found by the application.
 Also, after changing an installed .desktop file, you'll usually want to run 'kbuildsycoca4' to refresh the cached services, often your changes won't have effect immediately if you don't refresh the database.
@@ Line 132: / Line 153: @@
 * actions should have a "persistant" flag to execute them on every new page load, within a context
 * some way of automating the creation of those things (apps + actions) (webappeditor, in progress)

@@ Line 52: / Line 52: @@
 ** startUrl, AllowedBases
 ** KPluginInfo metadata, most importantly: X-KDE-PluginInfo-Name, which is used as parameter to selkie
-** config options, starting with: X-Silk-
+** config options, starting with: X-Silk- (These config options are defined in services/silk-webapp.desktop, which is the ServiceType for Silk/Webapp
-      (These config options are defined in services/silk-webapp.desktop, which is the ServiceType for Silk/Webapp
 The plugin .desktop file typically looks like:

@@ Line 129: / Line 129: @@
 *loading plugins as actions works for simple cases
 * loading javascript files from plugins works
-* showing and hiding action button not implemented yet
+* showing and hiding action button (parenturls + wildcards matching, works)
 * actions should have a "persistant" flag to execute them on every new page load, within a context
-* some way of automating the creation of those things (apps + actions)
+* some way of automating the creation of those things (apps + actions) (webappeditor, in progress)
 ... todo.