Gramplets - Revision history

Patsyblefebre: /* Hello World */ -

2013-01-28T00:51:27Z

‎Hello World: -

Patsyblefebre: /* Hello World */ image

2013-01-28T00:50:38Z

‎Hello World: image

Patsyblefebre: thumb

2013-01-28T00:47:38Z

thumb

Patsyblefebre: Gramps

2013-01-28T00:44:51Z

Gramps

Patsyblefebre: GrampletsDefault-40.png

2013-01-16T21:13:44Z

GrampletsDefault-40.png

Patsyblefebre: /* Learning More */ update

2012-12-28T00:25:06Z

‎Learning More: update

Patsyblefebre: /* Predifined Properties */ Predefined

2012-12-28T00:23:43Z

‎Predifined Properties: Predefined

Patsyblefebre: /* GUI Interface */ gramps.gen.plug

2012-12-27T22:58:29Z

‎GUI Interface: gramps.gen.plug

Patsyblefebre: /* Hello World, with Class */ highlight

2012-12-27T22:54:03Z

‎Hello World, with Class: highlight

Patsyblefebre: /* Hello World, with Class */ change "from gen.plug import Gramplet" to "from gramps.gen.plug import Gramplet" and update to 4.0

2012-12-27T22:52:46Z

‎Hello World, with Class: change "from gen.plug import Gramplet" to "from gramps.gen.plug import Gramplet" and update to 4.0

@@ Line 56: / Line 56: @@
 [[File:HelloWorldGramplet-40.png|thumb|left|Hello World Gramplet]]
 === Explanation ===
-The main work of a Gramplet is performed in a function, or a class. In this very simple example, a function '''init''' is defined that takes
+The main work of a Gramplet is performed in a function, or a class. In this very simple example, a function '''init''' is defined that takes a single argument, gui. The function simply sets the gui's text area to be "Hello World!", and that's it. It does this just once, and never changes.
 a single argument, gui. The function simply sets the gui's text area to be "Hello World!", and that's it. It does this just once, and never changes.
 Before a plugin can be used, it needs to be "registered". You call the register function with a number of named-arguments. There are a number of named-arguments that you can provide, including: name, height, content, title, expand, state, and data. We will explore those in detail, below.

@@ Line 55: / Line 55: @@
 If you place these files in '''your personal plugins directory''' (usually in ''.gramps/grampsxx/plugins/gramplet/'' ), and then restart Gramps, you will be able to create this Gramplet. On the Gramplet View, right-click in an open area and select the "Hello World Gramplet". You should then see:
-[[File:HelloWorldGramplet.png]]
+[[File:HelloWorldGramplet-40.png|thumb|left|Hello World Gramplet]]
 === Explanation ===

← Older revision		Revision as of 00:47, 28 January 2013
Line 3:		Line 3:
	A '''Gramplet''' is a type of Gramps plugin. Gramplets are mini-view that is designed to be composed with other Gramplets or Views to create a way to see your Family Tree that is just right for you. In fact, Gramplets can be made to do just about anything that you want.		A '''Gramplet''' is a type of Gramps plugin. Gramplets are mini-view that is designed to be composed with other Gramplets or Views to create a way to see your Family Tree that is just right for you. In fact, Gramplets can be made to do just about anything that you want.

−	[[File:GrampletsDefault-40.png\|400px\|right\|Gramplet]]	+	[[File:GrampletsDefault-40.png\|400px\|thumb\|right\|Gramplet]]

@@ Line 1: / Line 1: @@
 {{man warn|Warning:|Technical details about Gramplets for Developers. If you are interested in using Gramplets, please see [[Gramps 4.0 Wiki Manual - Gramplets]].}}
-A '''Gramplet''' is a type of GRAMPS plugin. Gramplets are mini-view that is designed to be composed with other Gramplets or Views to create a way to see your Family Tree that is just right for you. In fact, Gramplets can be made to do just about anything that you want.
+A '''Gramplet''' is a type of Gramps plugin. Gramplets are mini-view that is designed to be composed with other Gramplets or Views to create a way to see your Family Tree that is just right for you. In fact, Gramplets can be made to do just about anything that you want.
 [[File:GrampletsDefault-40.png|400px|right|Gramplet]]
@@ Line 53: / Line 53: @@
 You can read more about the gpr.py file in [[Addons development]] and the [http://svn.code.sf.net/p/gramps/code/trunk/gramps/gen/plug/_pluginreg.py source code implementation].
-If you place these files in '''your personal plugins directory''' (usually in ''.gramps/grampsxx/plugins/gramplet/'' ), and then restart GRAMPS, you will be able to create this Gramplet. On the Gramplet View, right-click in an open area and select the "Hello World Gramplet". You should then see:
+If you place these files in '''your personal plugins directory''' (usually in ''.gramps/grampsxx/plugins/gramplet/'' ), and then restart Gramps, you will be able to create this Gramplet. On the Gramplet View, right-click in an open area and select the "Hello World Gramplet". You should then see:
 [[File:HelloWorldGramplet.png]]
@@ Line 107: / Line 107: @@
 * '''status''': STABLE or UNSTABLE
 * '''version''': a string with 2 dots (such as "1.23.14") representing the version number
-* '''gramps_target_version''': a string with 2 dots representing the version of GRAMPS that this gramplet was written for
+* '''gramps_target_version''': a string with 2 dots representing the version of Gramps that this gramplet was written for
 * '''help_url''': the title of the wiki page that describes the gramplet
@@ Line 144: / Line 144: @@
 </pre>
-The method main() can be written as a normal Python method, or it can be written to run nicely in parallel with other GRAMPS code. To make it run nicely in parallel, you should issue a '''yield True''' every once in a while. For example:
+The method main() can be written as a normal Python method, or it can be written to run nicely in parallel with other Gramps code. To make it run nicely in parallel, you should issue a '''yield True''' every once in a while. For example:
 <pre>
@@ Line 253: / Line 253: @@
 </pre>
-In fact, with Python, gtk, and cairo, you can make your own widgets that do pretty much anything and look very nice. Here is an example adding a Cairo Clock (which really keeps time) to GRAMPS 3.4 : [https://gramps-addons.svn.sourceforge.net/svnroot/gramps-addons/branches/gramps34/download/ClockGramplet.addon.tgz ClockGramplet.addon.tgz]
+In fact, with Python, gtk, and cairo, you can make your own widgets that do pretty much anything and look very nice. Here is an example adding a Cairo Clock (which really keeps time) to Gramps 3.4 : [https://gramps-addons.svn.sourceforge.net/svnroot/gramps-addons/branches/gramps34/download/ClockGramplet.addon.tgz ClockGramplet.addon.tgz]
 Here it is on the Gramplet view:
@@ Line 312: / Line 312: @@
 To learn more about writing a Gramplet, it is suggested to look at the existing Gramplets. You can see a complete list of the Gramplet source code here:
-* [http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps34/src/plugins/gramplet/ GRAMPS 3.4 Gramplets]
+* [http://svn.code.sf.net/p/gramps/code/branches/maintenance/gramps34/src/plugins/gramplet/ Gramps 3.4 Gramplets]
-* [http://svn.code.sf.net/p/gramps/code/trunk/gramps/plugins/gramplet/ GRAMPS Trunk Gramplets]
+* [http://svn.code.sf.net/p/gramps/code/trunk/gramps/plugins/gramplet/ Gramps Trunk Gramplets]
 Click on a filename, to view the source code of that Gramplet.

← Older revision		Revision as of 21:13, 16 January 2013
Line 3:		Line 3:
	A '''Gramplet''' is a type of GRAMPS plugin. Gramplets are mini-view that is designed to be composed with other Gramplets or Views to create a way to see your Family Tree that is just right for you. In fact, Gramplets can be made to do just about anything that you want.		A '''Gramplet''' is a type of GRAMPS plugin. Gramplets are mini-view that is designed to be composed with other Gramplets or Views to create a way to see your Family Tree that is just right for you. In fact, Gramplets can be made to do just about anything that you want.

−	[[File:~~Gramplets~~.png\|400px\|right\|Gramplet]]	+	[[File:GrampletsDefault-40.png\|400px\|right\|Gramplet]]

@@ Line 315: / Line 315: @@
 * [http://svn.code.sf.net/p/gramps/code/trunk/gramps/plugins/gramplet/ GRAMPS Trunk Gramplets]
-Click on a filename, and then "(view)" to see the source code of that Gramplet.
+Click on a filename, to view the source code of that Gramplet.
 [[Category:Developers/General]]

@@ Line 284: / Line 284: @@
 * '''get_option(TEXT)'''
-== Predifined Properties ==
+== Predefined Properties ==
 There are a number of preset properties:

@@ Line 228: / Line 228: @@
 # File: Widget.py
 from gettext import gettext as _
-from gen.plug import Gramplet
+from gramps.gen.plug import Gramplet
 import gtk

@@ Line 94: / Line 94: @@
 </pre>
-This is the recommended method of creating a Gramplet. The following details describe the properties and methods of this class.
+This is the '''recommended method''' of creating a Gramplet. The following details describe the properties and methods of this class.
 == Register Options ==

@@ Line 70: / Line 70: @@
 <pre>
 # File: HelloWorld2.py
-from gen.plug import Gramplet
+from gramps.gen.plug import Gramplet
 class HelloWorldGramplet(Gramplet):
@@ Line 84: / Line 84: @@
           description = _("a program that says 'Hello World'"),
           version="0.0.1",
-          gramps_target_version="3.4",
+          gramps_target_version="4.0",
           status = STABLE,
           fname="HelloWorld2.py",