Äcdocutils.nodes document q)Åq}q(U nametypesq}q(X���registering a sitemapqNX ���configurationqNX���creating a sitemapqNX���enabling web searches: sitemapsq NuUsubstitution_defsq }qUparse_messagesq]q Ucurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hUregistering-a-sitemapqhU configurationqhUcreating-a-sitemapqh Uenabling-web-searches-sitemapsquUchildrenq]qcdocutils.nodes section q)Åq}q(U rawsourceqU�UparentqhUsourceqXV���/var/lib/jenkins/jobs/metacat-unstable/workspace/docs/user/metacat/source/sitemaps.rstqUtagnameq Usectionq!U attributesq"}q#(Udupnamesq$]Uclassesq%]Ubackrefsq&]Uidsq']q(haUnamesq)]q*h auUlineq+KUdocumentq,hh]q-(cdocutils.nodes title q.)Åq/}q0(hX���Enabling Web Searches: Sitemapsq1hhhhh Utitleq2h"}q3(h$]h%]h&]h']h)]uh+Kh,hh]q4cdocutils.nodes Text q5X���Enabling Web Searches: Sitemapsq6ÖÅq7}q8(hh1hh/ubaubcdocutils.nodes paragraph q9)Åq:}q;(hXß��Sitemaps are XML files that tell search engines - such as Google, which is discussed in this section - which URLs on your websites are available for crawling. Currently, the only way for a search engine to crawl and index Metacat so that individual metadata entries are available via Web searches is with a sitemap. Metacat automatically creates sitemaps for all public documents in the repository that meet these criteria:q<hhhhh U paragraphq=h"}q>(h$]h%]h&]h']h)]uh+Kh,hh]q?h5Xß��Sitemaps are XML files that tell search engines - such as Google, which is discussed in this section - which URLs on your websites are available for crawling. Currently, the only way for a search engine to crawl and index Metacat so that individual metadata entries are available via Web searches is with a sitemap. Metacat automatically creates sitemaps for all public documents in the repository that meet these criteria:q@ÖÅqA}qB(hh<hh:ubaubcdocutils.nodes bullet_list qC)ÅqD}qE(hU�hhhhh Ubullet_listqFh"}qG(UbulletqHX���-h']h&]h$]h%]h)]uh+Kh,hh]qI(cdocutils.nodes list_item qJ)ÅqK}qL(hX���Is publicly readableqMhhDhhh U list_itemqNh"}qO(h$]h%]h&]h']h)]uh+Nh,hh]qPh9)ÅqQ}qR(hhMhhKhhh h=h"}qS(h$]h%]h&]h']h)]uh+Kh]qTh5X���Is publicly readableqUÖÅqV}qW(hhMhhQubaubaubhJ)ÅqX}qY(hX���Is metadataqZhhDhhh hNh"}q[(h$]h%]h&]h']h)]uh+Nh,hh]q\h9)Åq]}q^(hhZhhXhhh h=h"}q_(h$]h%]h&]h']h)]uh+Kh]q`h5X���Is metadataqaÖÅqb}qc(hhZhh]ubaubaubhJ)Åqd}qe(hX(���Is the newest version in a version chainqfhhDhhh hNh"}qg(h$]h%]h&]h']h)]uh+Nh,hh]qhh9)Åqi}qj(hhfhhdhhh h=h"}qk(h$]h%]h&]h']h)]uh+K h]qlh5X(���Is the newest version in a version chainqmÖÅqn}qo(hhfhhiubaubaubhJ)Åqp}qq(hX���Is not archived hhDhhh hNh"}qr(h$]h%]h&]h']h)]uh+Nh,hh]qsh9)Åqt}qu(hX���Is not archivedqvhhphhh h=h"}qw(h$]h%]h&]h']h)]uh+Kh]qxh5X���Is not archivedqyÖÅqz}q{(hhvhhtubaubaubeubh9)Åq|}q}(hXZ���However, you must register the sitemaps with the search engine before it will take effect.q~hhhhh h=h"}q(h$]h%]h&]h']h)]uh+Kh,hh]qÄh5XZ���However, you must register the sitemaps with the search engine before it will take effect.qÅÖÅqÇ}qÉ(hh~hh|ubaubh)ÅqÑ}qÖ(hU�hhhhh h!h"}qÜ(h$]h%]h&]h']qáhah)]qàhauh+Kh,hh]qâ(h.)Åqä}qã(hX ���ConfigurationqåhhÑhhh h2h"}qç(h$]h%]h&]h']h)]uh+Kh,hh]qéh5X ���ConfigurationqèÖÅqê}që(hhåhhäubaubh9)Åqí}qì(hXY���Metacat's sitemaps functionality is controlled by three properties in metacat.properties.qîhhÑhhh h=h"}qï(h$]h%]h&]h']h)]uh+Kh,hh]qñh5XY���Metacat's sitemaps functionality is controlled by three properties in metacat.properties.qóÖÅqò}qô(hhîhhíubaubh9)Åqö}qõ(hX2��######## Sitemap section ######################################### # Sitemap Interval (in milliseconds) between rebuilding the sitemap sitemap.interval=86400000 # Base part of the URLs for the location of the sitemap files themselves. # Either full URL or absolute path. Trailing slash optional. sitemap.location.base=/metacatui # Base part of the URLs for the location entries in the sitemaps which should # be the base URL of the dataset landing page. # Either full URL or absolute path. Trailing slash optional. sitemap.entry.base=/metacatui/viewqúhhÑhhh h=h"}qù(h$]h%]h&]h']h)]uh+Kh,hh]qûh5X2��######## Sitemap section ######################################### # Sitemap Interval (in milliseconds) between rebuilding the sitemap sitemap.interval=86400000 # Base part of the URLs for the location of the sitemap files themselves. # Either full URL or absolute path. Trailing slash optional. sitemap.location.base=/metacatui # Base part of the URLs for the location entries in the sitemaps which should # be the base URL of the dataset landing page. # Either full URL or absolute path. Trailing slash optional. sitemap.entry.base=/metacatui/viewqüÖÅq†}q°(hhúhhöubaubhC)Åq¢}q£(hU�hhÑhhh hFh"}q§(hHX���-h']h&]h$]h%]h)]uh+K%h,hh]q•(hJ)Åq¶}qß(hXu���``sitemap.interval``: Controls the interval, in milliseconds, between rebuilding the sitemap index and sitemap files.hh¢hhh hNh"}q®(h$]h%]h&]h']h)]uh+Nh,hh]q©h9)Åq™}q´(hXu���``sitemap.interval``: Controls the interval, in milliseconds, between rebuilding the sitemap index and sitemap files.hh¶hhh h=h"}q¨(h$]h%]h&]h']h)]uh+K%h]q≠(cdocutils.nodes literal qÆ)ÅqØ}q∞(hX���``sitemap.interval``h"}q±(h$]h%]h&]h']h)]uhh™h]q≤h5X���sitemap.intervalq≥ÖÅq¥}qµ(hU�hhØubah Uliteralq∂ubh5Xa���: Controls the interval, in milliseconds, between rebuilding the sitemap index and sitemap files.q∑ÖÅq∏}qπ(hXa���: Controls the interval, in milliseconds, between rebuilding the sitemap index and sitemap files.hh™ubeubaubhJ)Åq∫}qª(hX-��``sitemap.location.base``: Controls the URL pattern used in the ``sitemap_index.xml`` file. You can use either a full URL (e.g., ``https://example.com/some_path``) or a URL relative to your server (e.g., ``/some_path``). This is different than the ``sitemap.entry.base`` property (see directly below).hh¢hhh hNh"}qº(h$]h%]h&]h']h)]uh+Nh,hh]qΩh9)Åqæ}qø(hX-��``sitemap.location.base``: Controls the URL pattern used in the ``sitemap_index.xml`` file. You can use either a full URL (e.g., ``https://example.com/some_path``) or a URL relative to your server (e.g., ``/some_path``). This is different than the ``sitemap.entry.base`` property (see directly below).hh∫hhh h=h"}q¿(h$]h%]h&]h']h)]uh+K'h]q¡(hÆ)Åq¬}q√(hX���``sitemap.location.base``h"}qƒ(h$]h%]h&]h']h)]uhhæh]q≈h5X���sitemap.location.baseq∆ÖÅq«}q»(hU�hh¬ubah h∂ubh5X'���: Controls the URL pattern used in the q…ÖÅq }qÀ(hX'���: Controls the URL pattern used in the hhæubhÆ)ÅqÃ}qÕ(hX���``sitemap_index.xml``h"}qŒ(h$]h%]h&]h']h)]uhhæh]qœh5X���sitemap_index.xmlq–ÖÅq—}q“(hU�hhÃubah h∂ubh5X,��� file. You can use either a full URL (e.g., q”ÖÅq‘}q’(hX,��� file. You can use either a full URL (e.g., hhæubhÆ)Åq÷}q◊(hX!���``https://example.com/some_path``h"}qÿ(h$]h%]h&]h']h)]uhhæh]qŸh5X���https://example.com/some_pathq⁄ÖÅq€}q‹(hU�hh÷ubah h∂ubh5X*���) or a URL relative to your server (e.g., q›ÖÅqfi}qfl(hX*���) or a URL relative to your server (e.g., hhæubhÆ)Åq‡}q·(hX���``/some_path``h"}q‚(h$]h%]h&]h']h)]uhhæh]q„h5X ���/some_pathq‰ÖÅqÂ}qÊ(hU�hh‡ubah h∂ubh5X���). This is different than the qÁÖÅqË}qÈ(hX���). This is different than the hhæubhÆ)ÅqÍ}qÎ(hX���``sitemap.entry.base``h"}qÏ(h$]h%]h&]h']h)]uhhæh]qÌh5X���sitemap.entry.baseqÓÖÅqÔ}q(hU�hhÍubah h∂ubh5X��� property (see directly below).qÒÖÅqÚ}qÛ(hX��� property (see directly below).hhæubeubaubhJ)ÅqÙ}qı(hX��``sitemap.entry.base``: Controls the URL pattern used for the entires in the individual sitemap files (e.g., ``sitemap1.xml``). You can use either a full URL (e.g., ``https://example.com/some_path``) or a URL relative to your server (e.g., ``/some_path``). hh¢hhh hNh"}qˆ(h$]h%]h&]h']h)]uh+Nh,hh]q˜h9)Åq¯}q˘(hX���``sitemap.entry.base``: Controls the URL pattern used for the entires in the individual sitemap files (e.g., ``sitemap1.xml``). You can use either a full URL (e.g., ``https://example.com/some_path``) or a URL relative to your server (e.g., ``/some_path``).hhÙhhh h=h"}q˙(h$]h%]h&]h']h)]uh+K,h]q˚(hÆ)Åq¸}q˝(hX���``sitemap.entry.base``h"}q˛(h$]h%]h&]h']h)]uhh¯h]qˇh5X���sitemap.entry.baser���ÖÅr��}r��(hU�hh¸ubah h∂ubh5XW���: Controls the URL pattern used for the entires in the individual sitemap files (e.g., r��ÖÅr��}r��(hXW���: Controls the URL pattern used for the entires in the individual sitemap files (e.g., hh¯ubhÆ)År��}r��(hX���``sitemap1.xml``h"}r��(h$]h%]h&]h']h)]uhh¯h]r ��h5X���sitemap1.xmlr ��ÖÅr��}r��(hU�hj��ubah h∂ubh5X(���). You can use either a full URL (e.g., r ��ÖÅr��}r��(hX(���). You can use either a full URL (e.g., hh¯ubhÆ)År��}r��(hX!���``https://example.com/some_path``h"}r��(h$]h%]h&]h']h)]uhh¯h]r��h5X���https://example.com/some_pathr��ÖÅr��}r��(hU�hj��ubah h∂ubh5X*���) or a URL relative to your server (e.g., r��ÖÅr��}r��(hX*���) or a URL relative to your server (e.g., hh¯ubhÆ)År��}r��(hX���``/some_path``h"}r��(h$]h%]h&]h']h)]uhh¯h]r��h5X ���/some_pathr��ÖÅr��}r ��(hU�hj��ubah h∂ubh5X���).r!��ÖÅr"��}r#��(hX���).hh¯ubeubaubeubeubh)År$��}r%��(hU�hhhhh h!h"}r&��(h$]h%]h&]h']r'��hah)]r(��hauh+K2h,hh]r)��(h.)År*��}r+��(hX���Creating a Sitemapr,��hj$��hhh h2h"}r-��(h$]h%]h&]h']h)]uh+K2h,hh]r.��h5X���Creating a Sitemapr/��ÖÅr0��}r1��(hj,��hj*��ubaubh9)År2��}r3��(hX{��Metacat automatically generates a sitemap file for all public documents in the repository on a daily basis. The sitemap file(s) must be available via the Web on your server, and must be registered with Google before they take effect. For information on the sitemap protocol, please refer to the Google page on using the sitemap protocol. You can view Metacat's sitemap files at::hj$��hhh h=h"}r4��(h$]h%]h&]h']h)]uh+K4h,hh]r5��h5Xz��Metacat automatically generates a sitemap file for all public documents in the repository on a daily basis. The sitemap file(s) must be available via the Web on your server, and must be registered with Google before they take effect. For information on the sitemap protocol, please refer to the Google page on using the sitemap protocol. You can view Metacat's sitemap files at:r6��ÖÅr7��}r8��(hXz��Metacat automatically generates a sitemap file for all public documents in the repository on a daily basis. The sitemap file(s) must be available via the Web on your server, and must be registered with Google before they take effect. For information on the sitemap protocol, please refer to the Google page on using the sitemap protocol. You can view Metacat's sitemap files at:hj2��ubaubcdocutils.nodes literal_block r9��)År:��}r;��(hX���<your_web_context>/sitemapshj$��hhh U literal_blockr<��h"}r=��(U xml:spacer>��Upreserver?��h']h&]h$]h%]h)]uh+K:h,hh]r@��h5X���<your_web_context>/sitemapsrA��ÖÅrB��}rC��(hU�hj:��ubaubh9)ÅrD��}rE��(hX%���The directory contains an index file:rF��hj$��hhh h=h"}rG��(h$]h%]h&]h']h)]uh+K<h,hh]rH��h5X%���The directory contains an index file:rI��ÖÅrJ��}rK��(hjF��hjD��ubaubcdocutils.nodes block_quote rL��)ÅrM��}rN��(hU�hj$��hhh Ublock_quoterO��h"}rP��(h$]h%]h&]h']h)]uh+Nh,hh]rQ��h9)ÅrR��}rS��(hX���sitemap_index.xmlrT��hjM��hhh h=h"}rU��(h$]h%]h&]h']h)]uh+K>h]rV��h5X���sitemap_index.xmlrW��ÖÅrX��}rY��(hjT��hjR��ubaubaubh9)ÅrZ��}r[��(hX)���and one or more sitemap XML files named::r\��hj$��hhh h=h"}r]��(h$]h%]h&]h']h)]uh+K@h,hh]r^��h5X(���and one or more sitemap XML files named:r_��ÖÅr`��}ra��(hX(���and one or more sitemap XML files named:hjZ��ubaubj9��)Årb��}rc��(hX���sitemap<X>.xmlhj$��hhh j<��h"}rd��(j>��j?��h']h&]h$]h%]h)]uh+KBh,hh]re��h5X���sitemap<X>.xmlrf��ÖÅrg��}rh��(hU�hjb��ubaubh9)Åri��}rj��(hXÛ���where ``<X>`` is a number (e.g., 1 or 2) used to increment each sitemap file. Because Metacat limits the number of sitemap entries in each sitemap file to 50,000, the servlet creates an additional sitemap file for each group of 50,000 entries.hj$��hhh h=h"}rk��(h$]h%]h&]h']h)]uh+KDh,hh]rl��(h5X���where rm��ÖÅrn��}ro��(hX���where hji��ubhÆ)Årp��}rq��(hX���``<X>``h"}rr��(h$]h%]h&]h']h)]uhji��h]rs��h5X���<X>rt��ÖÅru��}rv��(hU�hjp��ubah h∂ubh5XÊ��� is a number (e.g., 1 or 2) used to increment each sitemap file. Because Metacat limits the number of sitemap entries in each sitemap file to 50,000, the servlet creates an additional sitemap file for each group of 50,000 entries.rw��ÖÅrx��}ry��(hXÊ��� is a number (e.g., 1 or 2) used to increment each sitemap file. Because Metacat limits the number of sitemap entries in each sitemap file to 50,000, the servlet creates an additional sitemap file for each group of 50,000 entries.hji��ubeubh9)Årz��}r{��(hXH���Verify that your sitemap files are available to the Web by browsing to::r|��hj$��hhh h=h"}r}��(h$]h%]h&]h']h)]uh+KIh,hh]r~��h5XG���Verify that your sitemap files are available to the Web by browsing to:r��ÖÅrÄ��}rÅ��(hXG���Verify that your sitemap files are available to the Web by browsing to:hjz��ubaubj9��)ÅrÇ��}rÉ��(hXd���<your_web_context>/sitemaps/sitemap<X>.xml (e.g., https://example.org/metacat/sitemaps/sitemap1.xml)hj$��hhh j<��h"}rÑ��(j>��j?��h']h&]h$]h%]h)]uh+KKh,hh]rÖ��h5Xd���<your_web_context>/sitemaps/sitemap<X>.xml (e.g., https://example.org/metacat/sitemaps/sitemap1.xml)rÜ��ÖÅrá��}rà��(hU�hjÇ��ubaubeubh)Årâ��}rä��(hU�hhhhh h!h"}rã��(h$]h%]h&]h']rå��hah)]rç��hauh+KOh,hh]ré��(h.)Årè��}rê��(hX���Registering a Sitemaprë��hjâ��hhh h2h"}rí��(h$]h%]h&]h']h)]uh+KOh,hh]rì��h5X���Registering a Sitemaprî��ÖÅrï��}rñ��(hjë��hjè��ubaubh9)Åró��}rò��(hX¢���Before Google will begin indexing the public files in your Metacat, you must register the sitemaps. To register your sitemaps and ensure that they are up to date:rô��hjâ��hhh h=h"}rö��(h$]h%]h&]h']h)]uh+KPh,hh]rõ��h5X¢���Before Google will begin indexing the public files in your Metacat, you must register the sitemaps. To register your sitemaps and ensure that they are up to date:rú��ÖÅrù��}rû��(hjô��hjó��ubaubcdocutils.nodes enumerated_list rü��)År†��}r°��(hU�hjâ��hhh Uenumerated_listr¢��h"}r£��(Usuffixr§��U.h']h&]h$]Uprefixr•��U�h%]h)]Uenumtyper¶��Uarabicrß��uh+KTh,hh]r®��(hJ)År©��}r™��(hXZ���Register for a Google Webmaster Tools account, and add your Metacat site to the Dashboard.hj†��hhh hNh"}r´��(h$]h%]h&]h']h)]uh+Nh,hh]r¨��h9)År≠��}rÆ��(hXZ���Register for a Google Webmaster Tools account, and add your Metacat site to the Dashboard.rØ��hj©��hhh h=h"}r∞��(h$]h%]h&]h']h)]uh+KTh]r±��h5XZ���Register for a Google Webmaster Tools account, and add your Metacat site to the Dashboard.r≤��ÖÅr≥��}r¥��(hjØ��hj≠��ubaubaubhJ)Årµ��}r∂��(hX˙���From your Google Webmaster Tools site account, register your sitemaps. See the Google help site for more information about how to register sitemaps. Note: Register the full URL path to your sitemap files, including the http:// (or https://) headers. hj†��hhh hNh"}r∑��(h$]h%]h&]h']h)]uh+Nh,hh]r∏��h9)Årπ��}r∫��(hX˘���From your Google Webmaster Tools site account, register your sitemaps. See the Google help site for more information about how to register sitemaps. Note: Register the full URL path to your sitemap files, including the http:// (or https://) headers.hjµ��hhh h=h"}rª��(h$]h%]h&]h']h)]uh+KVh]rº��(h5X€���From your Google Webmaster Tools site account, register your sitemaps. See the Google help site for more information about how to register sitemaps. Note: Register the full URL path to your sitemap files, including the rΩ��ÖÅræ��}rø��(hX€���From your Google Webmaster Tools site account, register your sitemaps. See the Google help site for more information about how to register sitemaps. Note: Register the full URL path to your sitemap files, including the hjπ��ubcdocutils.nodes reference r¿��)År¡��}r¬��(hX���http://r√��h"}rƒ��(Urefurij√��h']h&]h$]h%]h)]uhjπ��h]r≈��h5X���http://r∆��ÖÅr«��}r»��(hU�hj¡��ubah U referencer…��ubh5X��� (or r ��ÖÅrÀ��}rÃ��(hX��� (or hjπ��ubj¿��)ÅrÕ��}rŒ��(hX���https://rœ��h"}r–��(Urefurijœ��h']h&]h$]h%]h)]uhjπ��h]r—��h5X���https://r“��ÖÅr”��}r‘��(hU�hjÕ��ubah j…��ubh5X ���) headers.r’��ÖÅr÷��}r◊��(hX ���) headers.hjπ��ubeubaubeubh9)Årÿ��}rŸ��(hXm���Once the sitemaps are registered, Google will begin to index the public documents in your Metacat repository.r⁄��hjâ��hhh h=h"}r€��(h$]h%]h&]h']h)]uh+K[h,hh]r‹��h5Xm���Once the sitemaps are registered, Google will begin to index the public documents in your Metacat repository.r›��ÖÅrfi��}rfl��(hj⁄��hjÿ��ubaubh9)År‡��}r·��(hX©���NOTE: As you add more publicly accessible data to Metacat, you will need to periodically revisit the Google Webmaster Tools utility to refresh your sitemap registration.r‚��hjâ��hhh h=h"}r„��(h$]h%]h&]h']h)]uh+K^h,hh]r‰��h5X©���NOTE: As you add more publicly accessible data to Metacat, you will need to periodically revisit the Google Webmaster Tools utility to refresh your sitemap registration.rÂ��ÖÅrÊ��}rÁ��(hj‚��hj‡��ubaubeubeubahU�UtransformerrË��NU footnote_refsrÈ��}rÍ��UrefnamesrÎ��}rÏ��Usymbol_footnotesrÌ��]rÓ��Uautofootnote_refsrÔ��]r��Usymbol_footnote_refsrÒ��]rÚ��U citationsrÛ��]rÙ��h,hUcurrent_linerı��NUtransform_messagesrˆ��]r˜��Ureporterr¯��NUid_startr˘��KU autofootnotesr˙��]r˚��U citation_refsr¸��}r˝��Uindirect_targetsr˛��]rˇ��Usettingsr���(cdocutils.frontend Values r��or��}r��(Ufootnote_backlinksr��KUrecord_dependenciesr��NUrfc_base_urlr��Uhttps://tools.ietf.org/html/r��U tracebackr��àUpep_referencesr ��NUstrip_commentsr ��NU toc_backlinksr��Uentryr��U language_coder ��Uenr��U datestampr��NUreport_levelr��KU_destinationr��NU halt_levelr��KU strip_classesr��Nh2NUerror_encoding_error_handlerr��Ubackslashreplacer��Udebugr��NUembed_stylesheetr��âUoutput_encoding_error_handlerr��Ustrictr��U 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_xmlr&��NUexpose_internalsr'��NUsectsubtitle_xformr(��âUsource_linkr)��NUrfc_referencesr*��NUoutput_encodingr+��Uutf-8r,��U source_urlr-��NUinput_encodingr.��U utf-8-sigr/��U_disable_configr0��NU id_prefixr1��U�U tab_widthr2��KUerror_encodingr3��UUTF-8r4��U_sourcer5��hUgettext_compactr6��àU generatorr7��NUdump_internalsr8��NUsmart_quotesr9��âUpep_base_urlr:��U https://www.python.org/dev/peps/r;��Usyntax_highlightr<��Ulongr=��Uinput_encoding_error_handlerr>��j��Uauto_id_prefixr?��Uidr@��Udoctitle_xformrA��âUstrip_elements_with_classesrB��NU _config_filesrC��]Ufile_insertion_enabledrD��àUraw_enabledrE��KU dump_settingsrF��NubUsymbol_footnote_startrG��K�h'}rH��(hhhhÑhjâ��hj$��uUsubstitution_namesrI��}rJ��h h,h"}rK��(h$]h']h&]Usourcehh%]h)]uU footnotesrL��]rM��UrefidsrN��}rO��ub.