From: Janos Kovacs Date: Sat, 5 May 2012 11:50:17 +0000 (+0300) Subject: documentation: plugin-developer-guide content update X-Git-Tag: build/2012-07-04.133153~68^2~3 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=4916b204141be42708d42fbf9596a94aa9938ab1;p=profile%2Fivi%2Fmurphy.git documentation: plugin-developer-guide content update --- diff --git a/doc/plugin-developer-guide/lyx/murphy-db-high-level-api.lyx b/doc/plugin-developer-guide/lyx/murphy-db-high-level-api.lyx new file mode 100644 index 0000000..6824497 --- /dev/null +++ b/doc/plugin-developer-guide/lyx/murphy-db-high-level-api.lyx @@ -0,0 +1,94 @@ +#LyX 2.0 created this file. For more info see http://www.lyx.org/ +\lyxformat 413 +\begin_document +\begin_header +\textclass docbook-chapter +\use_default_options true +\maintain_unincluded_children false +\language english +\language_package default +\inputencoding auto +\fontencoding global +\font_roman default +\font_sans default +\font_typewriter default +\font_default_family default +\use_non_tex_fonts false +\font_sc false +\font_osf false +\font_sf_scale 100 +\font_tt_scale 100 + +\graphics default +\default_output_format default +\output_sync 0 +\bibtex_command default +\index_command default +\paperfontsize default +\spacing single +\use_hyperref true +\pdf_bookmarks true +\pdf_bookmarksnumbered false +\pdf_bookmarksopen false +\pdf_bookmarksopenlevel 1 +\pdf_breaklinks false +\pdf_pdfborder false +\pdf_colorlinks true +\pdf_backref section +\pdf_pdfusetitle true +\papersize default +\use_geometry false +\use_amsmath 1 +\use_esint 1 +\use_mhchem 1 +\use_mathdots 1 +\cite_engine basic +\use_bibtopic false +\use_indices false +\paperorientation portrait +\suppress_date false +\use_refstyle 1 +\index Index +\shortcut idx +\color #008000 +\end_index +\secnumdepth 2 +\tocdepth 3 +\paragraph_separation skip +\defskip smallskip +\quotes_language english +\papercolumns 1 +\papersides 1 +\paperpagestyle default +\bullet 1 0 9 -1 +\bullet 2 0 15 -1 +\bullet 3 0 7 -1 +\tracking_changes false +\output_changes false +\html_math_output 0 +\html_css_as_file 0 +\html_be_strict false +\end_header + +\begin_body + +\begin_layout Title +High level API +\end_layout + +\begin_layout Standard +blah blah +\end_layout + +\begin_layout Standard +\begin_inset CommandInset include +LatexCommand input +filename "high-level-api-definition.xml" + +\end_inset + + +\end_layout + +\end_body +\end_document diff --git a/doc/plugin-developer-guide/lyx/murphy-db.lyx b/doc/plugin-developer-guide/lyx/murphy-db-introduction.lyx similarity index 84% rename from doc/plugin-developer-guide/lyx/murphy-db.lyx rename to doc/plugin-developer-guide/lyx/murphy-db-introduction.lyx index adb7ba4..6a5d8d1 100644 --- a/doc/plugin-developer-guide/lyx/murphy-db.lyx +++ b/doc/plugin-developer-guide/lyx/murphy-db-introduction.lyx @@ -73,11 +73,11 @@ \begin_body \begin_layout Title -Murphy Database +Introduction \end_layout -\begin_layout Section -Overview +\begin_layout Standard +blah blah \end_layout \begin_layout Standard @@ -87,10 +87,6 @@ sideways false status open \begin_layout Plain Layout - -\end_layout - -\begin_layout Plain Layout \begin_inset Caption \begin_layout Plain Layout @@ -120,27 +116,5 @@ Murphy DB components \end_layout -\begin_layout Section -Low level API -\end_layout - -\begin_layout Section -High Level API -\end_layout - -\begin_layout Section -Murphy Query Language -\end_layout - -\begin_layout Standard -\begin_inset CommandInset include -LatexCommand input -filename "mql-grammar.xml" - -\end_inset - - -\end_layout - \end_body \end_document diff --git a/doc/plugin-developer-guide/lyx/murphy-db-query-language.lyx b/doc/plugin-developer-guide/lyx/murphy-db-query-language.lyx new file mode 100644 index 0000000..9e588cd --- /dev/null +++ b/doc/plugin-developer-guide/lyx/murphy-db-query-language.lyx @@ -0,0 +1,102 @@ +#LyX 2.0 created this file. For more info see http://www.lyx.org/ +\lyxformat 413 +\begin_document +\begin_header +\textclass docbook-chapter +\use_default_options true +\maintain_unincluded_children false +\language english +\language_package default +\inputencoding auto +\fontencoding global +\font_roman default +\font_sans default +\font_typewriter default +\font_default_family default +\use_non_tex_fonts false +\font_sc false +\font_osf false +\font_sf_scale 100 +\font_tt_scale 100 + +\graphics default +\default_output_format default +\output_sync 0 +\bibtex_command default +\index_command default +\paperfontsize default +\spacing single +\use_hyperref true +\pdf_bookmarks true +\pdf_bookmarksnumbered false +\pdf_bookmarksopen false +\pdf_bookmarksopenlevel 1 +\pdf_breaklinks false +\pdf_pdfborder false +\pdf_colorlinks true +\pdf_backref section +\pdf_pdfusetitle true +\papersize default +\use_geometry false +\use_amsmath 1 +\use_esint 1 +\use_mhchem 1 +\use_mathdots 1 +\cite_engine basic +\use_bibtopic false +\use_indices false +\paperorientation portrait +\suppress_date false +\use_refstyle 1 +\index Index +\shortcut idx +\color #008000 +\end_index +\secnumdepth 2 +\tocdepth 3 +\paragraph_separation skip +\defskip smallskip +\quotes_language english +\papercolumns 1 +\papersides 1 +\paperpagestyle default +\bullet 1 0 9 -1 +\bullet 2 0 15 -1 +\bullet 3 0 7 -1 +\tracking_changes false +\output_changes false +\html_math_output 0 +\html_css_as_file 0 +\html_be_strict false +\end_header + +\begin_body + +\begin_layout Title +Murphy Query Language +\end_layout + +\begin_layout Section +Overview +\end_layout + +\begin_layout Standard +blah blah +\end_layout + +\begin_layout Section +Grammar +\end_layout + +\begin_layout Standard +\begin_inset CommandInset include +LatexCommand input +filename "mql-grammar.xml" + +\end_inset + + +\end_layout + +\end_body +\end_document diff --git a/doc/plugin-developer-guide/lyx/plugin-developer-guide.lyx b/doc/plugin-developer-guide/lyx/plugin-developer-guide.lyx index 5a73bbf..9d7af9e 100644 --- a/doc/plugin-developer-guide/lyx/plugin-developer-guide.lyx +++ b/doc/plugin-developer-guide/lyx/plugin-developer-guide.lyx @@ -88,99 +88,59 @@ Murphy in Brief blah blah bla .... \end_layout -\begin_layout Standard -this is the enumeration test: -\end_layout - -\begin_layout Itemize -First level bbbbbb -\end_layout - -\begin_deeper -\begin_layout Itemize -second level -\end_layout - -\begin_layout Itemize -another second level -\end_layout - -\end_deeper -\begin_layout Itemize -first level again -\end_layout - -\begin_layout Itemize -now we try third level as well -\end_layout - -\begin_deeper -\begin_layout Itemize -second +\begin_layout Description +This will be the first among description thing \end_layout -\begin_deeper -\begin_layout Itemize -third +\begin_layout Description +here we have the second \end_layout -\begin_layout Itemize -jjjjj +\begin_layout Description +and the third \end_layout -\end_deeper -\begin_layout Itemize -again second +\begin_layout Part +Basic Infrastructure \end_layout -\begin_deeper -\begin_layout Itemize -third +\begin_layout Part +Murphy Database \end_layout -\end_deeper -\end_deeper -\begin_layout Itemize -first -\end_layout +\begin_layout Standard +\begin_inset CommandInset include +LatexCommand input +filename "murphy-db-introduction.xml" -\begin_layout Enumerate -This is for 1 -\end_layout +\end_inset -\begin_layout Enumerate -for 2 -\end_layout -\begin_layout Enumerate -and for three \end_layout -\begin_layout Description -This will be the first among description thing -\end_layout +\begin_layout Standard +\begin_inset CommandInset include +LatexCommand input +filename "murphy-db-high-level-api.xml" -\begin_layout Description -here we have the second -\end_layout +\end_inset -\begin_layout Description -and the third -\end_layout -\begin_layout Part -Basic Infrastructure \end_layout \begin_layout Standard \begin_inset CommandInset include -LatexCommand include -filename "murphy-db.xml" +LatexCommand input +filename "murphy-db-query-language.xml" \end_inset \end_layout +\begin_layout Part +Plugin writing conventions +\end_layout + \end_body \end_document