From 4c25f4bd9eb0460afd6cc6a92fd55206df14dc79 Mon Sep 17 00:00:00 2001 From: Not Zed Date: Thu, 28 Oct 2004 09:30:28 +0000 Subject: setup for more auto-built stuff. 2004-10-28 Not Zed * evolution-plugin-manual.xml: setup for more auto-built stuff. * build-eplugin-manual.pl: auto-build more stuff. svn path=/trunk/; revision=27755 --- doc/devel/ChangeLog | 6 + doc/devel/build-eplugin-manual.pl | 182 +++++++----- doc/devel/evolution-plugin-manual.xml | 516 +++++++++------------------------- 3 files changed, 243 insertions(+), 461 deletions(-) (limited to 'doc') diff --git a/doc/devel/ChangeLog b/doc/devel/ChangeLog index 9de1bb25a1..efa2312005 100644 --- a/doc/devel/ChangeLog +++ b/doc/devel/ChangeLog @@ -1,3 +1,9 @@ +2004-10-28 Not Zed + + * evolution-plugin-manual.xml: setup for more auto-built stuff. + + * build-eplugin-manual.pl: auto-build more stuff. + 2004-10-12 Not Zed * evolution-plugin-manual.xml: doc updates for new 'check' callback. diff --git a/doc/devel/build-eplugin-manual.pl b/doc/devel/build-eplugin-manual.pl index f7e5569b63..8cb951a516 100755 --- a/doc/devel/build-eplugin-manual.pl +++ b/doc/devel/build-eplugin-manual.pl @@ -51,76 +51,75 @@ foreach $out (keys %byref) { # Event reference # -%events = ( 'em-events.xml' => - { 'files' => [ 'em-folder-view.c', 'em-composer-utils.c', 'mail-folder-cache.c' ], - 'module' => 'mail' }, - ); +# %events = ( 'em-events.xml' => +# { 'files' => [ 'em-folder-view.c', 'em-composer-utils.c', 'mail-folder-cache.c' ], +# 'module' => 'mail' }, +# ); -foreach $out (keys %events) { - print "generating events doc $out\n"; - %data = %{$events{$out}}; - @files = @{$data{'files'}}; - $module = $data{'module'}; - open OUT,">$out"; - foreach $file (@files) { - open IN,"<../../$module/$file"; - while () { - if (m/\@Event: (.*)/) { - $title = $1; - $name = $1; - $target = ""; - while () { - if (m/\@Title: (.*)/) { - $title = $1; - } elsif (m/\@Target: (.*)/) { - $target = $1; - } elsif (m/\* (.*)/) { - $desc.= $1."\n"; - } - last if (m/\*\//); - } - if ($target eq "") { - print "Warning: No target defined for event $name ($title)\n"; - } - print OUT < - $title - - - - - - - Name - $name - - - Target - - $target - - - - Description - - - $desc - - - - - - - -END - } - } - close IN; - } - close OUT; - -} +# foreach $out (keys %events) { +# print "generating events doc $out\n"; +# %data = %{$events{$out}}; +# @files = @{$data{'files'}}; +# $module = $data{'module'}; +# open OUT,">$out"; +# foreach $file (@files) { +# open IN,"<../../$module/$file"; +# while () { +# if (m/\@Event: (.*)/) { +# $title = $1; +# $name = $1; +# $target = ""; +# while () { +# if (m/\@Title: (.*)/) { +# $title = $1; +# } elsif (m/\@Target: (.*)/) { +# $target = $1; +# } elsif (m/\* (.*)/) { +# $desc.= $1."\n"; +# } +# last if (m/\*\//); +# } +# if ($target eq "") { +# print "Warning: No target defined for event $name ($title)\n"; +# } +# print OUT < +# $title +# +# +# +# +# +# +# Name +# $name +# +# +# Target +# +# $target +# +# +# +# Description +# +# +# $desc +# +# +# +# +# +# +# +# END +# } +# } +# close IN; +# } +# close OUT; +# } # # Generic table builder, still experimental. @@ -131,13 +130,16 @@ sub buildxml { my $out = $_[1]; my %data = %{$_[2]}; my @files, $module; + my $line; print "generating doc $out for $type\n"; @files = @{$data{'files'}}; $module = $data{'module'}; open OUT,">$out"; foreach $file (@files) { - open IN,"<../../$module/$file"; + my $line = 0; + + open IN,"<../../$module/$file" || die ("Cannot open \"$module/$file\""); while () { if (m/\/\*\* \@$type: (.*)/) { my $key = ""; @@ -148,6 +150,7 @@ sub buildxml { my @blobs = (); while () { + $line++; if (m/\@(.*): (.*)/) { if ($val ne "") { $blob{$key} = $val; @@ -176,6 +179,13 @@ sub buildxml { print OUT< $title +END + if ($val ne "") { + $val =~ s/[\n]+$//gos; + $val =~ s/\n\n/\<\/simpara\>\n\/g; + print OUT "$val\n"; + } + print OUT < @@ -192,17 +202,17 @@ END END } print OUT < + Defined + $module/$file:$line + + END - if ($val ne "") { - $val =~ s/[\n]+$//gos; - $val =~ s/\n\n/\<\/simpara\>\n\/g; - print OUT "$val\n"; - } - print OUT "\n"; } + $line++; } close IN; } @@ -222,6 +232,26 @@ END { 'type' => 'Event', 'files' => [ 'e-shell.c' ], 'module' => 'shell' }, + 'em-events.xml' => + { 'type' => 'Event', + 'files' => [ 'em-folder-view.c', 'em-composer-utils.c', 'mail-folder-cache.c' ], + 'module' => 'mail' }, + 'em-popups.xml' => + { 'type' => 'HookPoint-EMPopup', + 'files' => [ 'em-folder-tree.c', 'em-folder-view.c', 'em-format-html-display.c', '../composer/e-msg-composer-attachment-bar.c' ], + 'module' => 'mail' }, + 'ecal-popups.xml' => + { 'type' => 'HookPoint-ECalPopup', + 'files' => [ 'gui/e-calendar-view.c', 'gui/calendar-component.c', 'gui/e-calendar-view.c', 'gui/tasks-component.c' ], + 'module' => 'calendar' }, + 'em-configs.xml' => + { 'type' => 'HookPoint-EMConfig', + 'files' => [ 'em-mailer-prefs.c', 'em-account-editor.c', 'em-folder-properties.c', 'em-composer-prefs.c' ], + 'module' => 'mail' }, + 'em-menus.xml' => + { 'type' => 'HookPoint-EMMenu', + 'files' => [ 'em-folder-browser.c', 'em-message-browser.c' ], + 'module' => 'mail' }, ); foreach $out (keys %hooks) { diff --git a/doc/devel/evolution-plugin-manual.xml b/doc/devel/evolution-plugin-manual.xml index ad84699172..298944c36b 100644 --- a/doc/devel/evolution-plugin-manual.xml +++ b/doc/devel/evolution-plugin-manual.xml @@ -16,8 +16,13 @@ + + + + + @@ -1764,7 +1769,7 @@ - Name + Id The hook point id. @@ -1804,149 +1809,14 @@ The mail popup menu class is - com.ximian.evolution.mail.popup:1.0. + org.gnome.evolution.mail.popup:1.0. The plugin callback data will be the target matching the plugin menu itself, and the callback returns no value. - - Folder Tree Context Menu - - This is the context menu shown on the folder tree. - - - - - - - - Name - com.ximian.mail.storageset.popup.select - - - Target - - EMPopupTargetFolder - - - - - - - - - Message List Context Menu - - This is the context menu shown on the message list. - - - - - - - - Name - com.ximian.mail.folderview.popup.select - - - Target - - EMPopupTargetSelect - - - - - - - - - Inline URI Context Menu - - This is the context menu shown when clicking on inline URIs, - including addresses or normal HTML links that are displayed inside - the message view. - - - - - - - - Name - com.ximian.mail.folderview.popup.uri - - - Target - EMPopupTargetURI - - - - - - - - Inline Content and Attachment Context Menu - - This context menu is shown when right-clicking on inline images, or - when clicking on the attachment expander button. - - - - - - - - Name - com.ximian.mail.formathtmldisplay.popup.part - - - Target - EMPopupTargetPart - - - - - - - - Composer Attachment Bar Context Menu - - This context menu is displayed when the user brings up a context - menu on the attachment bar displayed in the composer. - - - - - - - - Name - com.novell.evolution.mail.composer.attachmentBar - - - Target - EMPopupTargetAttachments - - - Qualifiers - - - one = EM_POPUP_ATTACHMENTS_ONE - many = EM_POPUP_ATTACHMENTS_MANY - - - - - - - + &em-popups; Internal popup menus @@ -2182,95 +2052,14 @@ The mail popup menu class is - com.ximian.evolution.mail.bonobomenu:1.0. + org.gnome.evolution.mail.bonobomenu:1.0. The plugin callback data will be the target matching the plugin menu itself, and the callback returns no value. - - Main Mail Menu - - - This is the main mail view embedded in the &Evolution; Shell. - - - - - - - - - Name - com.novell.evolution.mail.browser - - - Target - - EMMenuTargetSelect - - - - - - - - - Standalone Message View Menu - - - This is the popup mail-message view. - - - - - - - - - Name - com.novell.evolution.mail.messagebrowser - - - Target - - EMMenuTargetSelect, - - - - - - - - - Composer Menu - - This is the mail message composer. This is currently not implemented. - - - - - - - - Name - com.novell.evolution.mail.composer - - - Target - Undefined - - - Qualifiers - Undefined - - - - - + &em-menus; Mail Menu Targets @@ -2333,168 +2122,10 @@ The mail config class is - com.novell.evolution.mail.config:1.0. + org.gnome.evolution.mail.config:1.0. - - Account Editor Druid - - This is the GnomeDruid which is shown when you create a new mail account. - - - - - - - - Name - com.novell.evolution.mail.config.accountDruid - - - Target - - EMConfigTargetAccount - - - - Items - Define some of the items available and where they fit - in the gui - - - - - - - - Account Editor Window - - This is the editor notebook which is shown when you edit an - existing mail account. - - - - - - - - Name - com.novell.evolution.mail.config.accountEditor - - - Target - - EMConfigTargetAccount, plugin target is "account". - - - - Items - Define some of the items available and where they fit - in the gui - - - - - - - - Composer Preferences - - This is the notebook of configuration items for the composer which - are accessed via the main settings window under the Composer tab. - - - - - - - - Name - com.novell.evolution.mail.composerPrefs - - - Target - - EMConfigTargetPrefs - - - - Items - Define some of the items available and where they fit - in the gui - - - - - - - - Mail Preferences - - This is the notebook of configuration items for the mailer which - are accessed via the main settings window under the Mail Settings tab. - - - - - - - - Name - com.novell.evolution.mail.prefs - - - Target - - EMConfigTargetPrefs - - - - Items - Define some of the items available and where they fit - in the gui - - - - - - - - Folder Properties - - This is the notebook of configuration items for a given mail folder - which is accessed via the Folder Properties item in the main menu item or - folder-tree context menu. - - - - - - - - Name - com.novell.evolution.mail.folderConfig - - - Target - - EMConfigTargetFolder - - - - Items - Define some of the items available and where they fit - in the gui - - - - - + &em-configs; Mail Config Targets @@ -2593,7 +2224,7 @@ The mail event class is - com.ximian.evolution.mail.events:1.0. + org.gnome.evolution.mail.events:1.0. &em-events; @@ -2858,17 +2489,132 @@ Contacts Hooks - None defined. + Hooks available in the the contacts component. + + + Popup menus + + + The contacts popup menu class is + org.gnome.evolution.addressbook.popup:1.0. + + + + + + Calendar Popup Targets + TBD + + + + + Main menus + + + The addressbook menu class is + org.gnome.evolution.addressbook.bonobomenu:1.0. + + + + + + Contacts Menu Targets + TBD + + + + + Config Windows and Druids + + The addressbook config class is + org.gnome.evolution.addressbook.config:1.0. + + + + + + Contacts Config Targets + TBD + + + + + Events + + + None defined. + + - Calendar and Tasks Hooks + Calendar Hooks - None defined. + Hooks available in the the calendar component. + + + Popup menus + + + The calendar popup menu class is + org.gnome.evolution.calendar.popup:1.0. + + + &ecal-popups; + + + Calendar Popup Targets + TBD + + + + + Main menus + + + The calendar menu class is + org.gnome.evolution.calendar.bonobomenu:1.0. + + + + + + Calendar Menu Targets + TBD + + + + + Config Windows and Druids + + The calendar config class is + org.gnome.evolution.calendar.config:1.0. + + + + + + Calendar Config Targets + TBD + + + + + Events + + + None defined. + + -- cgit v1.2.3