GNOME.org
 

tracker r2301 - in trunk: . docs/reference docs/reference/libtracker-common docs/reference/tracker-indexer

Author: mr
Date: Fri Oct  3 09:44:40 2008
New Revision: 2301
URL: http://svn.gnome.org/viewvc/tracker?rev=2301&view=rev

Log:
	* configure.ac:
	* docs/reference/Makefile.am:
	* docs/reference/libtracker-common/Makefile.am:
	* docs/reference/libtracker-common/libtracker-common-docs.sgml:
	* docs/reference/tracker-indexer/Makefile.am:
	* docs/reference/tracker-indexer/tracker-indexer-docs.sgml:
	* docs/reference/tracker-indexer/tracker-indexer-sections.txt:
	Added new documentation module for tracker-indexer module creation.


Added:
   trunk/docs/reference/tracker-indexer/
   trunk/docs/reference/tracker-indexer/Makefile.am
   trunk/docs/reference/tracker-indexer/tracker-indexer-docs.sgml
   trunk/docs/reference/tracker-indexer/tracker-indexer-sections.txt
   trunk/docs/reference/tracker-indexer/version.xml.in
Modified:
   trunk/ChangeLog
   trunk/configure.ac
   trunk/docs/reference/Makefile.am
   trunk/docs/reference/libtracker-common/Makefile.am
   trunk/docs/reference/libtracker-common/libtracker-common-docs.sgml

Modified: trunk/configure.ac
==============================================================================
--- trunk/configure.ac	(original)
+++ trunk/configure.ac	Fri Oct  3 09:44:40 2008
@@ -1098,6 +1098,8 @@
 	docs/reference/Makefile
 	docs/reference/libtracker-common/Makefile
 	docs/reference/libtracker-common/version.xml
+	docs/reference/tracker-indexer/Makefile
+	docs/reference/tracker-indexer/version.xml
 	filters/application/Makefile
 	filters/Makefile
 	filters/text/Makefile

Modified: trunk/docs/reference/Makefile.am
==============================================================================
--- trunk/docs/reference/Makefile.am	(original)
+++ trunk/docs/reference/Makefile.am	Fri Oct  3 09:44:40 2008
@@ -1,4 +1,6 @@
 include $(top_srcdir)/Makefile.decl
 
-SUBDIRS = libtracker-common
+SUBDIRS = 			\
+	libtracker-common 	\
+	tracker-indexer
 

Modified: trunk/docs/reference/libtracker-common/Makefile.am
==============================================================================
--- trunk/docs/reference/libtracker-common/Makefile.am	(original)
+++ trunk/docs/reference/libtracker-common/Makefile.am	Fri Oct  3 09:44:40 2008
@@ -26,11 +26,23 @@
 
 # CFLAGS and LDFLAGS for compiling scan program. Only needed
 # if $(DOC_MODULE).types is non-empty.
-INCLUDES = 					\
-	-I$(top_srcdir) 			\
-	-I$(top_builddir)
-
-# GTKDOC_LIBS =
+INCLUDES = 						\
+	-I$(top_srcdir)/src				\
+	$(HAL_CFLAGS)					\
+	$(DBUS_CFLAGS)					\
+	$(UNAC_CFLAGS)					\
+	$(PANGO_CFLAGS)					\
+	$(GIO_CFLAGS)					\
+	$(GLIB2_CFLAGS)
+
+GTKDOC_LIBS =						\
+	$(top_builddir)/src/libstemmer/libstemmer.la	\
+	$(HAL_LIBS)					\
+	$(DBUS_LIBS)					\
+	$(UNAC_LIBS)					\
+	$(PANGO_LIBS)					\
+	$(GIO_LIBS)					\
+	$(GLIB2_LIBS)
 
 
 # Extra options to supply to gtkdoc-mkdb

Modified: trunk/docs/reference/libtracker-common/libtracker-common-docs.sgml
==============================================================================
--- trunk/docs/reference/libtracker-common/libtracker-common-docs.sgml	(original)
+++ trunk/docs/reference/libtracker-common/libtracker-common-docs.sgml	Fri Oct  3 09:44:40 2008
@@ -21,7 +21,7 @@
 ]>
 <book id="index">
   <bookinfo>
-    <title>The libtracker-common Reference Manual</title>
+    <title>Tracker Common Library Reference Manual</title>
     <releaseinfo>for libtracker-common &version;</releaseinfo>
   </bookinfo>
   

Added: trunk/docs/reference/tracker-indexer/Makefile.am
==============================================================================
--- (empty file)
+++ trunk/docs/reference/tracker-indexer/Makefile.am	Fri Oct  3 09:44:40 2008
@@ -0,0 +1,81 @@
+include $(top_srcdir)/Makefile.decl
+
+AUTOMAKE_OPTIONS = 1.6
+
+# The name of the module.
+DOC_MODULE=tracker-indexer
+
+# The top-level SGML file.
+DOC_MAIN_SGML_FILE=tracker-indexer-docs.sgml
+
+# Extra options to supply to gtkdoc-scan
+# SCAN_OPTIONS=--deprecated-guards="G_GNUC_DEPRECATED"
+
+# Extra options to pass to gtkdoc-scangobj
+# SCANGOBJ_OPTIONS=--type-init-func="gtk_type_init(0)" 
+
+# The directory containing the source code. Relative to $(srcdir)
+DOC_SOURCE_DIR=../../../src/tracker-indexer
+
+# Used for dependencies
+HFILE_GLOB=$(top_srcdir)/src/tracker-indexer/*.h
+CFILE_GLOB=$(top_srcdir)/src/tracker-indexer/*.c
+
+# Header files to ignore when scanning
+IGNORE_HFILES=								\
+	tracker-dbus.c							\
+	tracker-dbus.h							\
+	tracker-indexer.c						\
+	tracker-indexer-db.c						\
+	tracker-indexer-db.h						\
+	tracker-indexer-glue.h						\
+	tracker-indexer-module.c					\
+	tracker-indexer-module.h					\
+	tracker-indexer.h						\
+	tracker-main.c							\
+	tracker-marshal.c						\
+	tracker-marshal.h						\
+	tracker-marshal-main.c
+
+
+# CFLAGS and LDFLAGS for compiling scan program. Only needed
+# if $(DOC_MODULE).types is non-empty.
+INCLUDES = 								\
+	-I$(top_srcdir)/src						\
+	$(DBUS_CFLAGS)							\
+	$(PANGO_CFLAGS)							\
+	$(GMODULE_CFLAGS)						
+
+GTKDOC_LIBS =								\
+	$(top_builddir)/src/libtracker-db/libtracker-db.la 		\
+	$(top_builddir)/src/libtracker-common/libtracker-common.la 	\
+	$(top_builddir)/src/libstemmer/libstemmer.la	 		\
+	$(trackerd_win_libs)						\
+	$(DBUS_LIBS)							\
+	$(GMODULE_LIBS)							\
+	$(GTHREAD_LIBS)							\
+	$(PANGO_LIBS)							\
+	$(GIO_LIBS)							\
+	$(GLIB2_LIBS)							\
+	-lz								\
+	-lm
+
+# Extra options to supply to gtkdoc-mkdb
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE)
+content_files =					\
+	version.xml
+
+expand_content_files =
+
+# Images to copy into HTML directory
+HTML_IMAGES =
+
+# Extra options to supply to gtkdoc-fixref
+FIXXREF_OPTIONS=
+
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+EXTRA_DIST += version.xml.in

Added: trunk/docs/reference/tracker-indexer/tracker-indexer-docs.sgml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/tracker-indexer/tracker-indexer-docs.sgml	Fri Oct  3 09:44:40 2008
@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"; [
+<!ENTITY tracker-module SYSTEM "xml/tracker-module.xml">
+<!ENTITY tracker-metadata SYSTEM "xml/tracker-metadata.xml">
+<!ENTITY tracker-metadata-utils SYSTEM "xml/tracker-metadata-utils.xml">
+<!ENTITY version SYSTEM "version.xml">
+]>
+<book id="index">
+  <bookinfo>
+    <title>Tracker Indexer Reference Manual</title>
+    <releaseinfo>for tracker-indexer &version;</releaseinfo>
+  </bookinfo>
+  
+  <part id="libtracker-common">
+    <title>Overview</title>
+    <partintro>
+      <para>
+	The tracker-indexer is responsible for indexing all content it is given. The indexer is completely modular, this means that there are modules or 'backends' which are used for indexing specific content types. This reference manual attempts to help developers write 3rd party modules to extract content not commonly supported by Tracker.
+      </para>
+      <para>
+      </para>
+    </partintro>
+  </part>
+
+    <chapter>
+      <title>Modules</title>
+      &tracker-module;
+    </chapter>
+
+    <chapter>
+      <title>Metadata</title>
+      &tracker-metadata;
+      &tracker-metadata-utils;
+    </chapter>
+</book>

Added: trunk/docs/reference/tracker-indexer/tracker-indexer-sections.txt
==============================================================================
--- (empty file)
+++ trunk/docs/reference/tracker-indexer/tracker-indexer-sections.txt	Fri Oct  3 09:44:40 2008
@@ -0,0 +1,55 @@
+<INCLUDE>tracker-indexer/tracker-module.h</INCLUDE>
+<SECTION>
+<FILE>tracker-module</FILE>
+<TITLE>Writing A Module</TITLE>
+TrackerFile
+
+TrackerModuleInit
+TrackerModuleShutdown
+
+TrackerModuleGetNameFunc
+TrackerModuleGetDirectoriesFunc
+
+TrackerModuleFileGetDataFunc
+TrackerModuleFileFreeDataFunc
+TrackerModuleFileGetServiceTypeFunc
+TrackerModuleFileGetUriFunc
+TrackerModuleFileGetMetadataFunc
+TrackerModuleFileGetText
+TrackerModuleFileIterContents
+
+tracker_module_init
+tracker_module_shutdown
+tracker_module_get_name
+tracker_module_file_get_data
+tracker_module_file_free_data
+tracker_module_file_get_service_type
+tracker_module_file_get_uri
+tracker_module_file_get_metadata
+tracker_module_file_get_text
+tracker_module_file_iter_contents
+</SECTION>
+
+<INCLUDE>tracker-indexer/tracker-metadata.h</INCLUDE>
+<SECTION>
+<FILE>tracker-metadata</FILE>
+<TITLE>Metadata Object</TITLE>
+TrackerMetadata
+TrackerMetadataForeach
+
+tracker_metadata_new
+tracker_metadata_free
+tracker_metadata_insert
+tracker_metadata_insert_multiple_values
+tracker_metadata_lookup
+tracker_metadata_lookup_multiple_values
+tracker_metadata_foreach
+</SECTION>
+
+<INCLUDE>tracker-indexer/tracker-metadata-utils.h</INCLUDE>
+<SECTION>
+<FILE>tracker-metadata-utils</FILE>
+<TITLE>Metadata Convenience Fallback Functions</TITLE>
+tracker_metadata_utils_get_data
+tracker_metadata_utils_get_text
+</SECTION>

Added: trunk/docs/reference/tracker-indexer/version.xml.in
==============================================================================
--- (empty file)
+++ trunk/docs/reference/tracker-indexer/version.xml.in	Fri Oct  3 09:44:40 2008
@@ -0,0 +1 @@
+ TRACKER_VERSION@
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]