Gnome-App Template Proposed Updates

[Eliot Landrum <eliot landrum cx>]

Hello All!

There were a couple of things bugging me about the gnome-app-template, so, in typical open source fashion, I modified it.

I've put my changes up at:

	http://eliot.landrum.cx/gdp/gnome-app-template/html/
	http://eliot.landrum.cx/gdp/gnome-app-template/gnome-app-template.sgml

Here's the major changes that I made, changes 1-6 are "meta" changes and the rest are specific changes:

1. Starting at the top, entities - I created two new entities and changed the name of the existing one. I get tired of typing "<application>MY-GNOME-APP</application>" so the first new one is <!ENTITY app "<application>MY-GNOME-APP</application>">. It's so much easier to type &app;. Secondly, I added &manver; because I always forget to change the manual version midway down the document. I changed &version; to &appver; to match the naming convention of &manver;.


2. I changed all sect1, sect2 and sect3's to section. For some reason I like <section> better... Mostly because they can be nested to infinity. It seems like I read that numbered sect's were going to be removed at some point, but now I can't find anything to back that up. Anyone know anything about this?


3. Section id's - I described this in the comments, but all sections and figures should have an id. To avoid id collitions, I've created a simple naming convention. A section is simply:

	section[-subsection][-subsubsection][...]

All figures are prefixed by figure- and have the same name as the section. If there are more than one images (like in the usage-menubar section of the template), then each figure has a new "subsection" name. For instance, figure-usage-menubar-file, figure-usage-menubar-edit, etc. The filename follows these names too.. just without the figure-. So I've got usage-menubar-file.png and usage-menubar-edit.png.


4. All comments to note sections are now in the format:

	<!-- BEGIN: SECTION -->
	
	<!-- BEGIN: SECTION-SUBSECTION -->

	<!-- END: SECTION-SUBSECTION -->

	<!-- END: SECTION -->

All of those ==='s gave me headache. None of them were of the same length either.. 


5. I changed the legalnotice to have the FSF's address be formatted the same as the license section (see lines 79-84).


6. Created a glade MY-GNOME-APP and took appropriate screenshots of the glade file. If someone can get it to build, we can include better shots without the black glade borders. My glade segfaults when I hit "build."


7. Added a usage-toolbar section talking about toolbar functions.


8. Added screenshots of each menu in the usage-menubar section. Also removed references to "you" in the menu item descriptions.


9. I completely overhauled the prefs section.


That's about it... Feel free to discuss any of these changes. Most of these are personal use choices, but I thought maybe the template would benefit from some of them.

-- 
Eliot Landrum
eliot@landrum.cx
GnuPG ID: 8F5B499E

-Soli Deo Gloria-

PGP signature