€cdocutils.nodes document q)q}q(U nametypesq}q(X outputschemasqˆX requirementsqNXoverviewqNXtestingq NXoutput schema pluginsq NXimplementing a new outputschemaq NuUsubstitution_defsq }q Uparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU outputschemasqhU requirementsqhUoverviewqh Utestingqh Uoutput-schema-pluginsqh Uimplementing-a-new-outputschemaquUchildrenq]q(cdocutils.nodes target q)q}q(U rawsourceq X.. _outputschemas:Uparentq!hUsourceq"X'/tmp/pycsw-2.0.2/docs/outputschemas.rstq#Utagnameq$Utargetq%U attributesq&}q'(Uidsq(]Ubackrefsq)]Udupnamesq*]Uclassesq+]Unamesq,]Urefidq-huUlineq.KUdocumentq/hh]ubcdocutils.nodes section q0)q1}q2(h Uh!hh"h#Uexpect_referenced_by_nameq3}q4hhsh$Usectionq5h&}q6(h*]h+]h)]h(]q7(hheh,]q8(h heuh.Kh/hUexpect_referenced_by_idq9}q:hhsh]q;(cdocutils.nodes title q<)q=}q>(h XOutput Schema Pluginsq?h!h1h"h#h$Utitleq@h&}qA(h*]h+]h)]h(]h,]uh.Kh/hh]qBcdocutils.nodes Text qCXOutput Schema PluginsqD…qE}qF(h h?h!h=ubaubh0)qG}qH(h Uh!h1h"h#h$h5h&}qI(h*]h+]h)]h(]qJhah,]qKhauh.Kh/hh]qL(h<)qM}qN(h XOverviewqOh!hGh"h#h$h@h&}qP(h*]h+]h)]h(]h,]uh.Kh/hh]qQhCXOverviewqR…qS}qT(h hOh!hMubaubcdocutils.nodes paragraph qU)qV}qW(h XÞpycsw allows for extending the implementation of output schemas to the core standard. outputschemas allow for a client to request metadata in a specific format (ISO, Dublin Core, FGDC, NASA DIF Atom and GM03 are default).qXh!hGh"h#h$U paragraphqYh&}qZ(h*]h+]h)]h(]h,]uh.K h/hh]q[hCXÞpycsw allows for extending the implementation of output schemas to the core standard. outputschemas allow for a client to request metadata in a specific format (ISO, Dublin Core, FGDC, NASA DIF Atom and GM03 are default).q\…q]}q^(h hXh!hVubaubhU)q_}q`(h XRAll outputschemas must be placed in the ``pycsw/plugins/outputschemas`` directory.qah!hGh"h#h$hYh&}qb(h*]h+]h)]h(]h,]uh.K h/hh]qc(hCX(All outputschemas must be placed in the qd…qe}qf(h X(All outputschemas must be placed in the h!h_ubcdocutils.nodes literal qg)qh}qi(h X``pycsw/plugins/outputschemas``h&}qj(h*]h+]h)]h(]h,]uh!h_h]qkhCXpycsw/plugins/outputschemasql…qm}qn(h Uh!hhubah$UliteralqoubhCX directory.qp…qq}qr(h X directory.h!h_ubeubeubh0)qs}qt(h Uh!h1h"h#h$h5h&}qu(h*]h+]h)]h(]qvhah,]qwhauh.Kh/hh]qx(h<)qy}qz(h X Requirementsq{h!hsh"h#h$h@h&}q|(h*]h+]h)]h(]h,]uh.Kh/hh]q}hCX Requirementsq~…q}q€(h h{h!hyubaubcdocutils.nodes literal_block q)q‚}qƒ(h XÑpycsw/ plugins/ __init__.py # empty outputschemas/ __init__.py # __all__ is a list of all provided outputschemas atom.py # default dif.py # default fgdc.py # default gm03.py # defaulth!hsh"h#h$U literal_blockq„h&}q…(Ulinenosq†‰Ulanguageq‡XnoneU xml:spaceqˆUpreserveq‰h(]h)]h*]Uhighlight_argsqŠ}h+]h,]uh.Kh/hh]q‹hCXÑpycsw/ plugins/ __init__.py # empty outputschemas/ __init__.py # __all__ is a list of all provided outputschemas atom.py # default dif.py # default fgdc.py # default gm03.py # defaultqŒ…q}qŽ(h Uh!h‚ubaubeubh0)q}q(h Uh!h1h"h#h$h5h&}q‘(h*]h+]h)]h(]q’hah,]q“h auh.Kh/hh]q”(h<)q•}q–(h XImplementing a new outputschemaq—h!hh"h#h$h@h&}q˜(h*]h+]h)]h(]h,]uh.Kh/hh]q™hCXImplementing a new outputschemaqš…q›}qœ(h h—h!h•ubaubhU)q}qž(h XNCreate a file in ``pycsw/plugins/outputschemas``, which defines the following:qŸh!hh"h#h$hYh&}q (h*]h+]h)]h(]h,]uh.Kh/hh]q¡(hCXCreate a file in q¢…q£}q¤(h XCreate a file in h!hubhg)q¥}q¦(h X``pycsw/plugins/outputschemas``h&}q§(h*]h+]h)]h(]h,]uh!hh]q¨hCXpycsw/plugins/outputschemasq©…qª}q«(h Uh!h¥ubah$houbhCX, which defines the following:q¬…q­}q®(h X, which defines the following:h!hubeubcdocutils.nodes bullet_list q¯)q°}q±(h Uh!hh"h#h$U bullet_listq²h&}q³(Ubulletq´X-h(]h)]h*]h+]h,]uh.K!h/hh]qµ(cdocutils.nodes list_item q¶)q·}q¸(h XQ``NAMESPACE``: the default namespace of the outputschema which will be advertisedq¹h!h°h"h#h$U list_itemqºh&}q»(h*]h+]h)]h(]h,]uh.Nh/hh]q¼hU)q½}q¾(h h¹h!h·h"h#h$hYh&}q¿(h*]h+]h)]h(]h,]uh.K!h]qÀ(hg)qÁ}qÂ(h X ``NAMESPACE``h&}qÃ(h*]h+]h)]h(]h,]uh!h½h]qÄhCX NAMESPACEqÅ…qÆ}qÇ(h Uh!hÁubah$houbhCXD: the default namespace of the outputschema which will be advertisedqÈ…qÉ}qÊ(h XD: the default namespace of the outputschema which will be advertisedh!h½ubeubaubh¶)qË}qÌ(h X@``NAMESPACE``: dict of all applicable namespaces to outputschemaqÍh!h°h"h#h$hºh&}qÎ(h*]h+]h)]h(]h,]uh.Nh/hh]qÏhU)qÐ}qÑ(h hÍh!hËh"h#h$hYh&}qÒ(h*]h+]h)]h(]h,]uh.K"h]qÓ(hg)qÔ}qÕ(h X ``NAMESPACE``h&}qÖ(h*]h+]h)]h(]h,]uh!hÐh]q×hCX NAMESPACEqØ…qÙ}qÚ(h Uh!hÔubah$houbhCX3: dict of all applicable namespaces to outputschemaqÛ…qÜ}qÝ(h X3: dict of all applicable namespaces to outputschemah!hÐubeubaubh¶)qÞ}qß(h Xd``XPATH_MAPPINGS``: dict of pycsw core queryables mapped to the equivalent XPath of the outputschemaqàh!h°h"h#h$hºh&}qá(h*]h+]h)]h(]h,]uh.Nh/hh]qâhU)qã}qä(h hàh!hÞh"h#h$hYh&}qå(h*]h+]h)]h(]h,]uh.K#h]qæ(hg)qç}qè(h X``XPATH_MAPPINGS``h&}qé(h*]h+]h)]h(]h,]uh!hãh]qêhCXXPATH_MAPPINGSqë…qì}qí(h Uh!hçubah$houbhCXR: dict of pycsw core queryables mapped to the equivalent XPath of the outputschemaqî…qï}qð(h XR: dict of pycsw core queryables mapped to the equivalent XPath of the outputschemah!hãubeubaubh¶)qñ}qò(h XV``write_record``: function which returns a record as an ``lxml.etree.Element`` object h!h°h"h#h$hºh&}qó(h*]h+]h)]h(]h,]uh.Nh/hh]qôhU)qõ}qö(h XU``write_record``: function which returns a record as an ``lxml.etree.Element`` objectq÷h!hñh"h#h$hYh&}qø(h*]h+]h)]h(]h,]uh.K$h]qù(hg)qú}qû(h X``write_record``h&}qü(h*]h+]h)]h(]h,]uh!hõh]qýhCX write_recordqþ…qÿ}r(h Uh!húubah$houbhCX(: function which returns a record as an r…r}r(h X(: function which returns a record as an h!hõubhg)r}r(h X``lxml.etree.Element``h&}r(h*]h+]h)]h(]h,]uh!hõh]rhCXlxml.etree.Elementr…r }r (h Uh!jubah$houbhCX objectr …r }r (h X objecth!hõubeubaubeubhU)r}r(h XeAdd the name of the file to ``__init__.py:__all__``. The new outputschema is now supported in pycsw.rh!hh"h#h$hYh&}r(h*]h+]h)]h(]h,]uh.K&h/hh]r(hCXAdd the name of the file to r…r}r(h XAdd the name of the file to h!jubhg)r}r(h X``__init__.py:__all__``h&}r(h*]h+]h)]h(]h,]uh!jh]rhCX__init__.py:__all__r…r}r(h Uh!jubah$houbhCX2. The new outputschema is now supported in pycsw.r…r}r(h X2. The new outputschema is now supported in pycsw.h!jubeubeubh0)r }r!(h Uh!h1h"h#h$h5h&}r"(h*]h+]h)]h(]r#hah,]r$h auh.K)h/hh]r%(h<)r&}r'(h XTestingr(h!j h"h#h$h@h&}r)(h*]h+]h)]h(]h,]uh.K)h/hh]r*hCXTestingr+…r,}r-(h j(h!j&ubaubhU)r.}r/(h XNew outputschemas must add examples to the :ref:`tests` interface, which must provide example requests specific to the profile.r0h!j h"h#h$hYh&}r1(h*]h+]h)]h(]h,]uh.K+h/hh]r2(hCX+New outputschemas must add examples to the r3…r4}r5(h X+New outputschemas must add examples to the h!j.ubcsphinx.addnodes pending_xref r6)r7}r8(h X :ref:`tests`r9h!j.h"h#h$U pending_xrefr:h&}r;(UreftypeXrefUrefwarnr<ˆU reftargetr=XtestsU refdomainXstdr>h(]h)]U refexplicit‰h*]h+]h,]Urefdocr?X outputschemasr@uh.K+h]rAcdocutils.nodes inline rB)rC}rD(h j9h&}rE(h*]h+]rF(UxrefrGj>Xstd-refrHeh)]h(]h,]uh!j7h]rIhCXtestsrJ…rK}rL(h Uh!jCubah$UinlinerMubaubhCXH interface, which must provide example requests specific to the profile.rN…rO}rP(h XH interface, which must provide example requests specific to the profile.h!j.ubeubeubeubeh UU transformerrQNU footnote_refsrR}rSUrefnamesrT}rUUsymbol_footnotesrV]rWUautofootnote_refsrX]rYUsymbol_footnote_refsrZ]r[U citationsr\]r]h/hU current_liner^NUtransform_messagesr_]r`cdocutils.nodes system_message ra)rb}rc(h Uh&}rd(h*]UlevelKh(]h)]Usourceh#h+]h,]UlineKUtypeUINFOreuh]rfhU)rg}rh(h Uh&}ri(h*]h+]h)]h(]h,]uh!jbh]rjhCX3Hyperlink target "outputschemas" is not referenced.rk…rl}rm(h Uh!jgubah$hYubah$Usystem_messagernubaUreporterroNUid_startrpKU autofootnotesrq]rrU citation_refsrs}rtUindirect_targetsru]rvUsettingsrw(cdocutils.frontend Values rxory}rz(Ufootnote_backlinksr{KUrecord_dependenciesr|NU rfc_base_urlr}Uhttps://tools.ietf.org/html/r~U tracebackrˆUpep_referencesr€NUstrip_commentsrNU toc_backlinksr‚UentryrƒU language_coder„Uenr…U datestampr†NU report_levelr‡KU _destinationrˆNU halt_levelr‰KU strip_classesrŠNh@NUerror_encoding_error_handlerr‹UbackslashreplacerŒUdebugrNUembed_stylesheetrŽ‰Uoutput_encoding_error_handlerrUstrictrU sectnum_xformr‘KUdump_transformsr’NU docinfo_xformr“KUwarning_streamr”NUpep_file_url_templater•Upep-%04dr–Uexit_status_levelr—KUconfigr˜NUstrict_visitorr™NUcloak_email_addressesršˆUtrim_footnote_reference_spacer›‰UenvrœNUdump_pseudo_xmlrNUexpose_internalsržNUsectsubtitle_xformrŸ‰U source_linkr NUrfc_referencesr¡NUoutput_encodingr¢Uutf-8r£U source_urlr¤NUinput_encodingr¥U utf-8-sigr¦U_disable_configr§NU id_prefixr¨UU tab_widthr©KUerror_encodingrªUUTF-8r«U_sourcer¬h#Ugettext_compactr­ˆU generatorr®NUdump_internalsr¯NU smart_quotesr°‰U pep_base_urlr±U https://www.python.org/dev/peps/r²Usyntax_highlightr³Ulongr´Uinput_encoding_error_handlerrµjUauto_id_prefixr¶Uidr·Udoctitle_xformr¸‰Ustrip_elements_with_classesr¹NU _config_filesrº]Ufile_insertion_enabledr»ˆU raw_enabledr¼KU dump_settingsr½NubUsymbol_footnote_startr¾KUidsr¿}rÀ(hh1hj hhshhGhh1hhuUsubstitution_namesrÁ}rÂh$h/h&}rÃ(h*]h(]h)]Usourceh#h+]h,]uU footnotesrÄ]rÅUrefidsrÆ}rÇh]rÈhasub.