{"title":"Kerangka peta situs","version":"6.1","locale":"id","docname":"ref/contrib/sitemaps","url":"/id/6.1/ref/contrib/sitemaps/","canonical":"https://djangodocs.dev/id/6.1/ref/contrib/sitemaps/","summary":"Django comes with a high-level sitemap-generating framework to create sitemap XML files.","html":"

Kerangka peta situsLink to this heading#

\n

Django comes with a high-level sitemap-generating framework to create sitemap\nXML files.

\n
\n

IkhtisarLink to this heading#

\n

Sebuah peta situs adalah sebuah berkas file pada situs jaringan anda yang memberitahu pengindeks mesin-pencari seberapa sering halaman anda berubah dan seberapa "penting" halaman tertentu berada dalam hubungan ke halaman lain pada situs anda. Informasi ini membantu mesin pencari mengindeks situs anda.

\n

Kerangka kerja peta situs Django mengotomatiskan pembuatan dari berkas XML ini dengan membiarkan anda menyatakan informasi ini di kode Python.

\n

It works much like Django's syndication framework. To create a sitemap, write a\nSitemap class and point to it in your\nURLconf.

\n
\n
\n

PemasanganLink to this heading#

\n

Untuk memasang aplikasi peta situs, ikuti langkah-langkah ini:

\n
    \n

  1. Tambah 'django.contrib.sitemaps' ke pengaturan INSTALLED_APPS anda.

    2. \n

  2. Pastikan pengaturan anda TEMPLATES mengandung sebuah backend DjangoTemplates yang pilihan APP_DIRS disetel menjadi True. Itu ada disana secara awalan, jadi anda hanya akan butuh merubah ini jika anda yelah merubah pengaturan itu.

    3. \n

  3. Pastikan anda telah memasang sites framework.

    4. \n
\n

(Catat: Aplikasi peta situs tidak memasang tabel-tabel basisdata apapun. Alasan satu-satunya itu butuh it needs untuk masuk INSTALLED_APPS adalah sehingga pemuat cetakan:func:~django.template.loaders.app_directories.Loader dapat menemukan cetakan-cetakan awalan.)

\n
\n
\n

InisialisasiLink to this heading#

\n
\n
\nviews.sitemap(request, sitemaps, section=None, template_name='sitemap.xml', content_type='application/xml')Link to this definition#
\n
\n\n

Untuk mengaktifkan pembangkitan peta situs pada situs Django anda, tambah baris ini ke URLconf anda:

\n
Code
from django.contrib.sitemaps.views import sitemap\n\npath(\n    "sitemap.xml",\n    sitemap,\n    {"sitemaps": sitemaps},\n    name="django.contrib.sitemaps.views.sitemap",\n)\n
\n

Ini mengatakan Django membangun sebuah peta situs ketika seorang klien mengakses /sitemap.xml.

\n

Nama dari berkas peta situs adalah tidak penting, tetapi tempat penting. Mesin pencari hanya mengindeks tautan dalam peta situs anda untuk tingkat URL saat ini dan dibawah. Sebagai contoh, jika sitemap.xml tinggal dalam direktori akar anda, itu mungkin mengacu URL apapun dalam situs anda. Bagaimanapun, jika peta situs anda tinggal di /content/sitemap.xml, itu mungkin hanya mengacu URL yang dimulai dengan /content/.

\n

Tampilan peta situs mengambil sebuah tambahan, argumen diwajibkan: {'sitemaps': sitemaps}. sitemaps harus berupa dictionary yang memetakan label bagian pendek (misalnya., blog atau news) ke kelas Sitemap nya (misalnya, BlogSitemap atau NewsSitemap). Ity mungkin juga memetakan ke sebuah instance dari kelas Sitemap (misalnya, BlogSitemap(some_var)).

\n
\n
\n

Kelas SitemapLink to this heading#

\n

A Sitemap class is a Python class that\nrepresents a "section" of entries in your sitemap. For example, one\nSitemap class could represent all the entries\nof your blog, while another could represent all of the events in your events\ncalendar.

\n

Dalam kasus tersederhana, semua bagian-bagian ini semua bagian ini dapat lumpuh bersama-sama menjadi satu sitemap.xml, tetapi itu juga memungkinkan menggunakan kerangka kerja untuk membangkitkan indeks peta situs yang mengacu berkas-berkas peta situs masing-masing, satu per bagian. (Lihat Creating a sitemap index dibawah ini.)

\n

Kelas-kelas Sitemap harus mengsubkelaskan django.contrib.sitemaps.Sitemap. Mereka dapat tinggal dimana saja dalam basis kode anda.

\n
\n
\n

Sebuah contohLink to this heading#

\n

Mari kita beranggapan anda mempunyai sebuah sistem blog, dengan sebuah model Entry, dan anda ingin peta situs anda menyertakan semua tautan ke masukan blog pribadi anda. Ini adalah bagaimana kelas petasitus anda mungkin terlihat:

\n
Code
from django.contrib.sitemaps import Sitemap\nfrom blog.models import Entry\n\n\nclass BlogSitemap(Sitemap):\n    changefreq = "never"\n    priority = 0.5\n\n    def items(self):\n        return Entry.objects.filter(is_draft=False)\n\n    def lastmod(self, obj):\n        return obj.pub_date\n
\n

Catatan:

\n\n
\n
\n

Acuan kelas SitemapLink to this heading#

\n
\n
\nclass SitemapLink to this definition#
\n

Sebuah kelas Sitemap dapat menentukan metode/atribut berikut:

\n
\n
\nitems()Link to this definition#
\n

Required. A method that returns a sequence or QuerySet\nof objects. The framework doesn't care what type of objects they are;\nall that matters is that these objects get passed to the\nlocation, lastmod,\nchangefreq and priority methods.

\n
\n\n
\n
\nlocationLink to this definition#
\n

Pilihan. Antara sebuah metode atau atribut.

\n

If it's a method, it should return the absolute path for a given object\nas returned by items().

\n

If it's an attribute, its value should be a string representing an\nabsolute path to use for every object returned by\nitems().

\n

Di kedua kasus, "absolute path" berarti sebuah URL yang tidak menyertakan protokol atau ranah. Contoh:

\n
    \n

  • Good: '/foo/bar/'

    • \n

  • Bad: 'example.com/foo/bar/'

    • \n

  • Buruk: 'https://example.com/foo/bar/'

    • \n
\n

If location isn't provided, the framework will call\nthe get_absolute_url() method on each object as returned by\nitems.

\n

Untuk menentukan sebuah protokol selain dari 'http', gunakan protocol.

\n
\n\n
\n
\nlastmodLink to this definition#
\n

Pilihan. Antara sebuah metode atau atribut.

\n

If it's a method, it should take one argument -- an object as returned\nby items() -- and return that object's last-modified\ndate/time as a datetime.

\n

If it's an attribute, its value should be a datetime\nrepresenting the last-modified date/time for every object returned by\nitems().

\n

Jika semua barang dalam peta situs memiliki lastmod, peta situs dibangkitkan oleh views.sitemap() akan mempunyai kepala Last-Modified setara pada lastmod terakhir. Anda dapat mengaktifkan ConditionalGetMiddleware untuk membuat Django menjawab sesuai permintaan dengan sebuah kepala If-Modified-Since yang akan mencegah mengirim peta situs jika itu belum berubah.

\n
\n\n
\n
\npaginatorLink to this definition#
\n

Pilihan.

\n

This property returns a Paginator for\nitems(). If you generate sitemaps in a batch you may\nwant to override this as a cached property in order to avoid multiple\nitems() calls.

\n
\n\n
\n
\nchangefreqLink to this definition#
\n

Pilihan. Antara sebuah metode atau atribut.

\n

If it's a method, it should take one argument -- an object as returned\nby items() -- and return that object's change\nfrequency as a string.

\n

If it's an attribute, its value should be a string representing the\nchange frequency of every object returned by items().

\n

Nilai memungkinkan untuk changefreq, apakah anda menggunakan sebuah metode atau atribut, adalah:

\n
    \n

  • 'always'

    • \n

  • 'hourly'

    • \n

  • 'daily'

    • \n

  • 'daily'

    • \n

  • 'daily'

    • \n

  • 'yearly'

    • \n

  • 'never'

    • \n
\n
\n\n
\n
\npriorityLink to this definition#
\n

Pilihan. Antara sebuah metode atau atribut.

\n

If it's a method, it should take one argument -- an object as returned\nby items() -- and return that object's priority as\neither a string or float.

\n

If it's an attribute, its value should be either a string or float\nrepresenting the priority of every object returned by\nitems().

\n

Contoh nilai-nilai untuk priority: 0.4, 1.0. Prioritas awalan dari sebuah halaman adalah 0.5. Lihat sitemaps.org documentation untuk beberapa.

\n
\n\n
\n
\nprotocolLink to this definition#
\n

Pilihan.

\n

This attribute defines the protocol ('http' or 'https') of the\nURLs in the sitemap. If it isn't set, the protocol with which the\nsitemap was requested is used. If the sitemap is built outside the\ncontext of a request, the default is 'https'.

\n
\n\n
\n
\nlimitLink to this definition#
\n

Pilihan.

\n

Atribut ini menentukan angka maksimal dari URL disertakan pada setiap halaman dari peta situs. Nilainya tidak harus melebihi nilai awalan dari 50000, yang merupakan batas teratas diijinkan dalam Sitemaps protocol.

\n
\n\n
\n
\ni18nLink to this definition#
\n

Pilihan.

\n

Sebuah atribut boolean yang menentukan jika URL dari peta situs ini harus dibangkitkan menggunakan semua LANGUAGES anda. Awalan adalah False.

\n
\n\n
\n
\nlanguagesLink to this definition#
\n

Pilihan.

\n

A sequence of language codes to use for\ngenerating alternate links when i18n is enabled.\nDefaults to LANGUAGES.

\n
\n\n
\n
\nalternatesLink to this definition#
\n

Pilihan.

\n

A boolean attribute. When used in conjunction with\ni18n generated URLs will each have a list of alternate\nlinks pointing to other language versions using the hreflang\nattribute. The default is False.

\n
\n\n
\n
\nx_defaultLink to this definition#
\n

Pilihan.

\n

A boolean attribute. When True the alternate links generated by\nalternates will contain a hreflang="x-default"\nfallback entry with a value of LANGUAGE_CODE. The default is\nFalse.

\n
\n\n
\n
\nget_latest_lastmod()Link to this definition#
\n

Optional. A method that returns the latest value returned by\nlastmod. This function is used to add the lastmod\nattribute to Sitemap index context\nvariables.

\n

By default get_latest_lastmod() returns:

\n
    \n

  • If lastmod is an attribute:\nlastmod.

    • \n

  • If lastmod is a method:\nThe latest lastmod returned by calling the method with all\nitems returned by items().

    • \n
\n
\n\n
\n
\nget_languages_for_item(item)Link to this definition#
\n

Optional. A method that returns the sequence of language codes for\nwhich the item is displayed. By default\nget_languages_for_item() returns\nlanguages.

\n
\n\n
\n\n
\n
\n

Jalan pintasLink to this heading#

\n

Kerangka kerja peta situs menyediakan sebuah kelas mudah untuk kasus tertentu:

\n
\n
\nclass GenericSitemap(info_dict, priority=None, changefreq=None, protocol=None)Link to this definition#
\n

The django.contrib.sitemaps.GenericSitemap class allows you to\ncreate a sitemap by passing it a dictionary which has to contain at least\na queryset entry. This queryset will be used to generate the items\nof the sitemap. It may also have a date_field entry that\nspecifies a date field for objects retrieved from the queryset.\nThis will be used for the lastmod attribute and\nget_latest_lastmod() methods in the generated sitemap.

\n

Argumen kata kunci priority, changefreq, dan protocol mengizinkan menentukan atribut-atribut ini untuk semua URL.

\n
\n\n
\n

ContohLink to this heading#

\n

Ini adalah contoh dari URLconf menggunakan GenericSitemap:

\n
Code
from django.contrib.sitemaps import GenericSitemap\nfrom django.contrib.sitemaps.views import sitemap\nfrom django.urls import path\nfrom blog.models import Entry\n\ninfo_dict = {\n    "queryset": Entry.objects.all(),\n    "date_field": "pub_date",\n}\n\nurlpatterns = [\n    # some generic view using info_dict\n    # ...\n    # the sitemap\n    path(\n        "sitemap.xml",\n        sitemap,\n        {"sitemaps": {"blog": GenericSitemap(info_dict, priority=0.6)}},\n        name="django.contrib.sitemaps.views.sitemap",\n    ),\n]\n
\n
\n
\n
\n

Peta situs untuk tampilan tetapLink to this heading#

\n

Sering anda ingin perayap mesin pencari untuk mengindeks tampilan-tampilan yang tidak juga halaman-halaman rinci obyek maupun halaman datar. Pemecahanannya adalah secara tersirat daftar nama-nama URL untuk tampilan-tampilan ini dalam items dan panggil reverse() dalam metode location dari peta situs. Sebagai contoh:

\n
Code
# sitemaps.py\nfrom django.contrib import sitemaps\nfrom django.urls import reverse\n\n\nclass StaticViewSitemap(sitemaps.Sitemap):\n    priority = 0.5\n    changefreq = "daily"\n\n    def items(self):\n        return ["main", "about", "license"]\n\n    def location(self, item):\n        return reverse(item)\n\n\n# urls.py\nfrom django.contrib.sitemaps.views import sitemap\nfrom django.urls import path\n\nfrom .sitemaps import StaticViewSitemap\nfrom . import views\n\nsitemaps = {\n    "static": StaticViewSitemap,\n}\n\nurlpatterns = [\n    path("", views.main, name="main"),\n    path("about/", views.about, name="about"),\n    path("license/", views.license, name="license"),\n    # ...\n    path(\n        "sitemap.xml",\n        sitemap,\n        {"sitemaps": sitemaps},\n        name="django.contrib.sitemaps.views.sitemap",\n    ),\n]\n
\n
\n
\n

Membuat indeks peta situsLink to this heading#

\n
\n
\nviews.index(request, sitemaps, template_name='sitemap_index.xml', content_type='application/xml', sitemap_url_name='django.contrib.sitemaps.views.sitemap')Link to this definition#
\n
\n\n

Kerangka kerja peta situs juga memiliki kemampuan membuat sebuah indeks peta situs yang mengacu ke berkas-berkas peta situs masing-masing, satu per setiap bagian ditentukan dalam dictionary sitemaps anda. Perbedaan hanya dalam penggunaan adalah:

\n\n

Ini adalah apa yang baris-barus URLconf bersangkutan akan terlihat untuk contoh diatas:

\n
Code
from django.contrib.sitemaps import views\n\nurlpatterns = [\n    path(\n        "sitemap.xml",\n        views.index,\n        {"sitemaps": sitemaps},\n        name="django.contrib.sitemaps.views.index",\n    ),\n    path(\n        "sitemap-<section>.xml",\n        views.sitemap,\n        {"sitemaps": sitemaps},\n        name="django.contrib.sitemaps.views.sitemap",\n    ),\n]\n
\n

Ini akan otomatis membangkirkan sebuah berkas sitemap.xml yang mengacu kedua sitemap-flatpages.xml dan sitemap-blog.xml. Kelas-kelas Sitemap dan dict sitemaps tidak berubah sama sekali.

\n

If all sitemaps have a lastmod returned by\nget_latest_lastmod() the sitemap index will have a\nLast-Modified header equal to the latest lastmod.

\n

Anda harus membuat sebuah berkas indeks jika satu dari peta situs anda mempunyai lebh dari 50,000 URL. Dalam kasus ini, Django akan otomatis memberikan nomor peta situs, dan indeks akan mencerminkan itu.

\n

Jika anda tidak menggunakan tampilan peta situs vanilla -- sebagai contoh, jika itu dibungkus dengan penghias cache --anda harus menamai tampilanpeta situs anda dan melewatkan sitemap_url_name ke tampilan indeks:

\n
Code
from django.contrib.sitemaps import views as sitemaps_views\nfrom django.views.decorators.cache import cache_page\n\nurlpatterns = [\n    path(\n        "sitemap.xml",\n        cache_page(86400)(sitemaps_views.index),\n        {"sitemaps": sitemaps, "sitemap_url_name": "sitemaps"},\n    ),\n    path(\n        "sitemap-<section>.xml",\n        cache_page(86400)(sitemaps_views.sitemap),\n        {"sitemaps": sitemaps},\n        name="sitemaps",\n    ),\n]\n
\n
\n
\n

Penyesuaian cetakanLink to this heading#

\n

Jika anda berharap menggunakan cetakan berbeda untuk setiap peta situs atau indeks peta situs tersedia pada situs anda, anda mungkin menentukan itu dengan melewatkan parameter template_name ke tampilan sitemap dan index melalui URLconf:

\n
Code
from django.contrib.sitemaps import views\n\nurlpatterns = [\n    path(\n        "custom-sitemap.xml",\n        views.index,\n        {"sitemaps": sitemaps, "template_name": "custom_sitemap.html"},\n        name="django.contrib.sitemaps.views.index",\n    ),\n    path(\n        "custom-sitemap-<section>.xml",\n        views.sitemap,\n        {"sitemaps": sitemaps, "template_name": "custom_sitemap.html"},\n        name="django.contrib.sitemaps.views.sitemap",\n    ),\n]\n
\n

Tampilan ini mengembalikan instance TemplateResponse yang mengizinkan anda dengan mudah menyesuaikan data tanggapan sebelum membangun. Untuk rincian lebih, lihat TemplateResponse documentation.

\n
\n

Variabel konteksLink to this heading#

\n

Ketika penyesuaian cetakan untuk tampilan index() dan sitemap(), anda dapat bergantung padavariabel konteks berikut.

\n
\n
\n

IndeksLink to this heading#

\n

The variable sitemaps is a list of objects containing the location and\nlastmod attribute for each of the sitemaps. Each URL exposes the following\nattributes:

\n\n
\n
\n

Peta situsLink to this heading#

\n

Variabel urlset adalah daftar dari URL yang harus muncul dalam peta situs. Setiap URL menampilkan atribut-atribut seperti ditentukan dalam kelas Sitemap:

\n\n

The alternates attribute is available when i18n and\nalternates are enabled. It is a list of other language\nversions, including the optional x_default fallback, for each\nURL. Each alternate is a dictionary with location and lang_code keys.

\n

The item attribute has been added for each URL to allow more flexible\ncustomization of the templates, such as Google news sitemaps. Assuming\nSitemap's items() would return a list of items with\npublication_data and a tags field something like this would\ngenerate a Google News compatible sitemap:

\n
Xml Django
<?xml version="1.0" encoding="UTF-8"?>\n<urlset\n  xmlns="https://www.sitemaps.org/schemas/sitemap/0.9"\n  xmlns:news="https://www.google.com/schemas/sitemap-news/0.9">\n{% spaceless %}\n{% for url in urlset %}\n  <url>\n    <loc>{{ url.location }}</loc>\n    {% if url.lastmod %}<lastmod>{{ url.lastmod|date:"Y-m-d" }}</lastmod>{% endif %}\n    {% if url.changefreq %}<changefreq>{{ url.changefreq }}</changefreq>{% endif %}\n    {% if url.priority %}<priority>{{ url.priority }}</priority>{% endif %}\n    <news:news>\n      {% if url.item.publication_date %}<news:publication_date>{{ url.item.publication_date|date:"Y-m-d" }}</news:publication_date>{% endif %}\n      {% if url.item.tags %}<news:keywords>{{ url.item.tags }}</news:keywords>{% endif %}\n    </news:news>\n   </url>\n{% endfor %}\n{% endspaceless %}\n</urlset>\n
\n
\n
","rootId":"module-django.contrib.sitemaps","toc":[{"title":"Ikhtisar","anchor":"overview","children":[]},{"title":"Pemasangan","anchor":"installation","children":[]},{"title":"Inisialisasi","anchor":"initialization","children":[]},{"title":"Kelas Sitemap","anchor":"sitemap-classes","children":[]},{"title":"Sebuah contoh","anchor":"an-example","children":[]},{"title":"Acuan kelas Sitemap","anchor":"sitemap-class-reference","children":[]},{"title":"Jalan pintas","anchor":"shortcuts","children":[{"title":"Contoh","anchor":"example","children":[]}]},{"title":"Peta situs untuk tampilan tetap","anchor":"sitemap-for-static-views","children":[]},{"title":"Membuat indeks peta situs","anchor":"creating-a-sitemap-index","children":[]},{"title":"Penyesuaian cetakan","anchor":"template-customization","children":[{"title":"Variabel konteks","anchor":"context-variables","children":[]},{"title":"Indeks","anchor":"index","children":[]},{"title":"Peta situs","anchor":"id1","children":[]}]}],"breadcrumbs":[{"docname":"ref/index","title":"Acuan API","url":"/id/6.1/ref/"},{"docname":"ref/contrib/index","title":"Paket contrib","url":"/id/6.1/ref/contrib/"}],"prev":{"docname":"ref/contrib/redirects","title":"Aplikasi pengalihan","url":"/id/6.1/ref/contrib/redirects/"},"next":{"docname":"ref/contrib/sites","title":"Kerangka kerja \"sites\"","url":"/id/6.1/ref/contrib/sites/"},"formats":{"html":"/id/6.1/ref/contrib/sitemaps/","markdown":"/id/6.1/ref/contrib/sitemaps.md","json":"/id/6.1/ref/contrib/sitemaps.json"},"source":"https://github.com/django/django/blob/stable/6.1.x/docs/ref/contrib/sitemaps.txt","official":"https://docs.djangoproject.com/id/6.1/ref/contrib/sitemaps/","inVersions":["6.1","6.0","5.2","5.1","5.0","4.2","4.1","4.0","3.2","3.1","3.0","2.2","2.1","2.0","1.11","1.10","1.9"],"inLocales":["en","sv","zh-hans","ga","fr","ja","id","it","pt-br","ko","es","el","pl"]}