From ef585975d00ddbc021fa9a1181723c67b3223a82 Mon Sep 17 00:00:00 2001 From: Federico Mena Quintero Date: Wed, 29 Nov 2000 16:26:59 +0000 Subject: Added an id for the API reference . Added the FDL . 2000-11-29 Federico Mena Quintero * evolution-devel-guide.sgml: Added an id for the API reference . Added the FDL . Added the preface and toplevel reference entities. Added entities for Evolution, Wombat, and Camel. Added an appendix for the GNU FDL. * preface.sgml: New file with the introduction to the Evolution Developer's Guide. * reference.sgml: Split the toplevel reference part into its own file. * fdl.sgml: Added the GNU Free Documentation License. * calendar/evolution-calendar.sgml: Added an id for the . * calendar/public-reference.sgml: Added an id for the . Moved this file over from calendar/reference.sgml. * Makefile.am (local_entities): Added a list of the SGML files that define entities for inclusion in the toplevel document. This way we can track documentation file dependencies down to all levels. (html/index.html): Made the toplevel document depend on $(local_entities). Also, removed the "html" target and put its contents directly here; this way we avoid having .PHONY targets. (EXTRA_DIST): Removed the evolution_devel_guideDATA; it made no sense. (content_files): Added preface.sgml and reference.sgml. svn path=/trunk/; revision=6715 --- doc/devel/calendar/architecture.sgml | 10 +++---- .../calendar/cal-util/tmpl/cal-component.sgml | 2 +- doc/devel/calendar/evolution-calendar.sgml | 32 +++++++++++----------- doc/devel/calendar/public-reference.sgml | 4 +-- doc/devel/calendar/reference.sgml | 24 ---------------- 5 files changed, 24 insertions(+), 48 deletions(-) delete mode 100644 doc/devel/calendar/reference.sgml (limited to 'doc/devel/calendar') diff --git a/doc/devel/calendar/architecture.sgml b/doc/devel/calendar/architecture.sgml index 08e4c82b35..f121144d29 100644 --- a/doc/devel/calendar/architecture.sgml +++ b/doc/devel/calendar/architecture.sgml @@ -2,10 +2,10 @@ Architecture of the Calendar - This chapter gives an overview of the Evolution Calendar + This chapter gives an overview of the &Evolution; Calendar architecture. It describes the model/view split of the calendar - into a personal calendar server, or PCS, and the GUI clients - that appear inside the Evolution shell. + into a personal calendar server, or &PCS;, and the GUI clients + that appear inside the &Evolution; Shell. @@ -14,7 +14,7 @@ Model/View Separation - Like other base components in Evolution, the calendar + Like other base components in &Evolution;, the calendar separates the data model from the views or clients. This is done so that multiple clients can access the same calendar data in an orderly fashion and without clashes. For example, @@ -30,7 +30,7 @@ - Evolution puts the calendar storage in a daemon called the + &Evolution; puts the calendar storage in a daemon called the Wombat and completely separates it from clients who wants to access calendar data. This part of the Wombat is called the personal calendar server, or &PCS;. Clients must contact the diff --git a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml index 2f800e583f..56a04b02a0 100644 --- a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml +++ b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml @@ -95,7 +95,7 @@ RFC 2445 iCalendar component object. These values are used as identifiers for #ETable columns. These - are used by the calendar GUI code in Evolution. + are used by the calendar GUI code in &Evolution;. @CAL_COMPONENT_FIELD_CATEGORIES: Component's list of categories. diff --git a/doc/devel/calendar/evolution-calendar.sgml b/doc/devel/calendar/evolution-calendar.sgml index f3936d9bbc..82015689ec 100644 --- a/doc/devel/calendar/evolution-calendar.sgml +++ b/doc/devel/calendar/evolution-calendar.sgml @@ -1,4 +1,4 @@ - + @@ -13,30 +13,30 @@ - Developing Applications for the Evolution Calendar + Developing Applications with the &Evolution; Calendar - This part of the Evolution Developer's Guide describes how to - write applications for the Evolution Calendar by using its - public interfaces. The Evolution Calendar exports its + This part of the &Evolution; Developer's Guide describes how + to write applications for the &Evolution; Calendar by using + its public interfaces. The &Evolution; Calendar exports its functionality through a number of interfaces, including CORBA, GTK+ wrappers for Bonobo objects, and other utility libraries. + This part also describes the internals of the calendar so that + it will be easy for you to make changes to &Evolution;'s core + code. - You should read this part of the Evolution Developer's guide + You should read this part of the &Evolution; Developer's guide if you intend to write client applications that use the - functionality of the Evolution Calendar. - - - - This part does not describe the internal interfaces of the - Evolution Calendar; for that you should read the Evolution - Internals Guide. You should only need to read that guide if - you are interested in the way the calendar works internally or - if you want to make changes directly to the Evolution Calendar - code. + functionality of the &Evolution; Calendar, such as its storage + interfaces and generic recurrence engine. If you intend to + make changes to the calendar's core code, it will be useful to + read the sections on the calendar internals as well. Even if + you do not intend to modify the core code of the calendar, it + may be useful to know a few things about the way it works so + that you can make better use of the public interfaces. diff --git a/doc/devel/calendar/public-reference.sgml b/doc/devel/calendar/public-reference.sgml index f8aa6e848d..b880bd2972 100644 --- a/doc/devel/calendar/public-reference.sgml +++ b/doc/devel/calendar/public-reference.sgml @@ -1,10 +1,10 @@ - + Calendar Public API Reference This part presents the class and function reference for the - public APIs of the different components of the Evolution + public APIs of the different components of the &Evolution; Calendar. diff --git a/doc/devel/calendar/reference.sgml b/doc/devel/calendar/reference.sgml deleted file mode 100644 index f8aa6e848d..0000000000 --- a/doc/devel/calendar/reference.sgml +++ /dev/null @@ -1,24 +0,0 @@ - - Calendar Public API Reference - - - - This part presents the class and function reference for the - public APIs of the different components of the Evolution - Calendar. - - - - &CalClient; - &CalComponent; - &cal-util; - &cal-recur; - &timeutil; - - - -- cgit v1.2.3