Outdated version of the documentation. Find the latest one here.

Panduan Dokumentasi

Pengenalan

Ini adalah panduan tentang penggunaan umum rst dalam dokumentasi QGIS. Dokumentasi akan membangun secara otomatis pada server 0, 8am, 4pm PDT (Pacific Daylight Time). Status sekarang tersedia di http://docs.qgis.org.

Lihat juga: http://sphinx.pocoo.org/markup/inline.html atau berkas convention.rst.

Secara umum, saat membuat dokumentasi rst untuk proyek QGIS, silakan ikuti garis panduan gaya dokumentasi Python.

Menggunakan tajuk

Menambahkan headline baru, Anda harus menggunakan gaya untuk bab, bagian, subbagian dan minisec berikut.

tajuk

********
Chapter
********

Section
=======

Subsection
----------

Minisec
.......

Tengara sebaris

  • Pintasan papan ketik:

    :kbd:`ctrl B`

    akan tampil Ctrl B

  • Menu gui

    :menuselection:`menu --> submenu`
  • NamaBerkas

    :file:`README.rst`
  • Ikon dengan popup teks milik Ikon

    |icon| :sup:`popup_text`

    (lihat image below).

  • Judul Dialog dan Tab

    :guilabel:`title`
  • Teks Pengguna

    ``label``
    

Catatan kaki

Harap dicatat: Catatan kaki tidak diakui oleh perangkat lunak terjemahan dan juga tidak dikonversi ke format pdf dengan benar. Jadi, jika tidak menggunakan catatan kaki dalam dokumentasi.

Hal ini untuk membuat catatan kaki

blabla [1]_

Yang akan mengarah ke:

[1]

Pembaruan plugin inti

Label/referensi

Hal ini digunakan untuk membuat referensi di suatu tempat

.. _my_anchor:

Label/reference
===============

Ini akan memanggil referensi dalam halaman yang sama

see my_anchor_ for more information. Notice how it will jump to
the following line/thing following the 'anchor'.
Normally to declare this label you do not need to use apastroph's but
you do need to use empty lines before and after the anchor. If you use
:ref:`my_anchor` it will display the caption instead
(In this case the title of this section!)

Jadi referensi 1 (my_anchor) dan referensi 2 Label/referensi

Karena referensi sering menampilkan keterangan lengkap, tidak perlu menggunakan bagian kata

see :ref:`my_anchor`

Figur dan gambar

Figur

.. _figure_readme_1:

.. only:: html

   **Figure Readme 1:**

.. figure:: /static/common/qgislogo.png
   :width: 20 em
   :align: center

   A caption: A logo I like

Hasilnya terlihat seperti ini:

Figure Readme 1:

../../_images/qgislogo.png

Sebuah keterangan: Sebuah logo Saya suka

Gunakan .. only:: html untuk membuat nomor untuk figur (Figure Readme 1) terlihat hanya dalam berkas html. Skrip akan memasukkan nomor secara otomatis sebelum keterangan dari figur dalam pdf.

Untuk menggunakan keterangan/caption (lihat keterangan saya) hanya memasukkan teks indent setelah baris kosong di blok figur.

Mengacu pada figur tersebut dapat dilakukan dengan dua cara pertama yang menggunakan label referensi seperti ini

(see Figure_Readme_1_).

Ini akan tampil seperti Figure_Readme_1. Anda dapat menggunakan huruf besar jika Anda ingin. Hal ini dapat digunakan dalam dokumen .rst yang sama tetapi tidak dalam dokumen .rst lainnya.

Anda tidak dapat menggunakan referensi seperti ini lagi, karena dalam referensi html untuk judul hilang (sekarang mengacu pada tempat sebelum Figure Readme 1:

see :ref:`figure_readme_1`, does not work due to the lost reference to
the caption of the figure, this is not a 'bug' but a choice we made!

Tabel-tabel

tabel sederhana

=======  =======  =======
x        y        z
=======  =======  =======
1        2        3
2        4
=======  =======  =======

Menggunakan \ diikuti oleh ruang kososng ‘ ‘ meninggalkan ruang kosong.

Anda juga dapat menggunakan tabel lebih komplek dengan menggambar mereka menggunakan semua referensi

.. _my_drawn_table_1:

+---------------+--------------------+
| Windows       | Mac OSX            |
+---------------+--------------------+
| |win|         | |osx|              |
+---------------+--------------------+
| and of course not to forget |nix|  |
+------------------------------------+

My drawn table, mind you this is unfortunately not regarded a caption

You can reference to it like this my_drawn_table_1_.

Hasil:

Windows Mac OSX
win osx

dan tentu saja tidak lupa nix

Meja gambar Saya, pikiran Anda ini sayangnya tidak dianggap keterangan

Anda dapat referensi seperti ini my_drawn_table_1.

Gambar-gambar

Gambar

.. image:: /static/common/qgislogo.png
   :width: 10 em

Penggantian

Anda dapat menempatkan gambar di dalam teks atau menambahkan alias. Untuk menggunakan gambar di dalam sebuah paragraf, hanya membuat alias di suatu tempat.

.. |nice_logo| image:: /static/common/qgislogo.png
               :width: 2 em

dan di paragraf Anda.

my paragraph begins here with a nice logo |nice_logo|.

Berikut adalah bagaimana contoh ini menjadi:

paragraf saya dimulai di sini dengan logo yang bagus nice_logo.

Indeks

Beberapa tag indeks ada di RST. Untuk dapat menerjemahkan indeks, perlu untuk mengintegrasikan ke dalam teks biasa. Dalam hal ini menggunakan sintaks ini:

QGIS allows to load several :index:`Vector formats` supported by GDAL/OGR ...

Jika istilah tersebut tidak harus diterjemahkan, silakan gunakan sintaks ini:

.. index:: WMS, WFS, WCS, CAT, SFS, GML, ...

Tambahkan cuplikan layar baru

Here are some hints to create new, nice looking screenshots. For the user guide they go into ./resources/en/user_manual/

  • lingkungan yang sama untuk semua topi layar (OS yang sama, dekorasi sama, ukuran font yang sama)

  • mengurangi jendela ke ruang minimum yang diperlukan untuk menunjukkan fitur (mengambil semua layar untuk small modal window > overkill)

  • mengurangi kekacauan, semakin baik (tidak perlu untuk mengaktifkan semua toolbar)

  • don’t resize them in an image editor, the size will be set into the rst files if necessary (downscaling the dimensions without properly upping the resolution > ugly)
  • Potong latar belakang

  • Set print size resolution to 135 dpi (this way, if no size is set in the rst files, images will be at original size in html and at a good print resolution in the PDF)
  • simpan mereka dalam png (no jpeg artifacts)

  • Cuplikan layar harus menunjukkan isi sesuai dengan apa yang dijelaskan dalam teks

  • you can find some prepared QGIS -projects that were used before to create screenshots in ./qgis-projects. This makes it easier to reproduce screenshots for the next version of QGIS. These projects use the QGIS sample dataset which should be placed in the same folder as the QGIS-Documentation Repository.
  • Use the following command to remove the global menu function in Ubuntu to create smaller application screens with menu’s.
sudo apt-get autoremove appmenu-gtk appmenu-gtk3 appmenu-qt

Terjemahkan Cuplikan Layar

Here are some hints to create screenshots for your translated user guide. They will go into ./resources/<your language>/user_manual/

  • lingkungan yang sama untuk semua topi layar (OS yang sama, dekorasi sama, ukuran font yang sama)

  • use the QGIS -projects included in QGIS-Documentation repository (in ./qgis_projects ). These were used to produce the ‘original’ screenshots in the manual. The QGIS Sample dataset should be placed in the same folder as the QGIS-Documentation Repository.
  • ukuran yang sama dengan cuplikan layar Inggris ‘asli’, jika tidak mereka akan meregang dan terlihat jelek. Jika Anda perlu memiliki ukuran yang berbeda karena string ui lagi, jangan lupa untuk mengubah dimensi dalam kode rst bahasa Anda.

  • mengurangi jendela ke ruang minimum yang diperlukan untuk menunjukkan fitur (mengambil semua layar untuk small modal window > overkill)

  • mengurangi kekacauan, semakin baik (tidak perlu untuk mengaktifkan semua toolbar)

  • tidak mengubah ukuran mereka dalam editor foto, ukuran akan ditetapkan ke dalam file terlebih dulu (downscaling the dimensions without properly upping the resolution > ugly)

  • Potong latar belakang

  • simpan mereka dalam png (no jpeg artifacts)

  • Cuplikan layar harus menunjukkan isi sesuai dengan apa yang dijelaskan dalam teks

Documenting Processing algorithms

If you want to write documentation for Processing algorithms consider this guidelines:

  • don’t overwrite existing help files by files from other sources (e.g. QGIS source tree or Processing-Help repository), this files have different formats
  • Processing algorithm help files are part of QGIS User Guide, so use same formatting as User Guide and other documentation
  • avoid use “This algoritm does this and that...” as first sentence in algorithm description. Try to use more general words like in TauDEM or GRASS algoritms help
  • add images if needed. Use PNG format and follow general guidelines for documentation.
  • if necessary add links to additional information (e.g. publications or web-pages) to the “See also” section
  • give clear explanation for algorithm parameters and outputs (again GRASS and TauDEM are good examples).
  • don’t edit parameter or output names. If you found typo or wrong spelling — report this in bugracker, so developers can fix this in Processing code too
  • don’t list available options in algorithm description, options already listed in parameter description.
  • don’t add information vector geometry type in algorithm or parameter description without compelling reason as this information already available in parameter description