summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShulhan <m.shulhan@gmail.com>2020-04-11 18:17:34 +0700
committerShulhan <m.shulhan@gmail.com>2020-04-11 18:18:28 +0700
commit788f063efa5af1fe58d0db78427c942455a59aee (patch)
tree22a2b4e1a196417b9c4ad03b8ecde4328f45c46e
parentd044fe5904d4a5301ad32b85cb5a61cf6326ea57 (diff)
downloadkamusku-788f063efa5af1fe58d0db78427c942455a59aee.tar.xz
all: pembaruan dokumentasi dan README
Tambahkan informasi tentang Bot Telegram dan definisi API. Samakan isi antara halaman HTML dengan README di Github.
-rw-r--r--README.adoc105
-rw-r--r--_www-kbbi/index.html94
2 files changed, 175 insertions, 24 deletions
diff --git a/README.adoc b/README.adoc
index f1a9de2..0dcef73 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,35 +1,108 @@
= kbbi
-kbbi adalah antarmuka perintah dan pustaka bahasa Go untuk situs
-https://kbbi.kemdikbud.go.id[Kamus Besar Bahasa Indonesia (KBBI)].
+Proyek sumber terbuka implementasi antar-muka perintah dan API untuk Kamus
+Besar Bahasa Indonesia.
-== Penggunaan
-Secara sederhana, perintah `kbbi` menerima satu atau lebih parameter berupa
-kata-kata yang ingin diketahui maknanya dalam Bahasa Indonesia.
+== Program kbbi
+
+Program kbbi yaitu antar-muka untuk mencari definisi dari kata lewat baris
+perintah.
+
+Program ini sangat sederhana, caranya yaitu dengan memberikan kata yang dicari
+setelah nama program, misalnya,
----
-$ kbbi <KATA>...
+$ kbbi kamus,bahasa
----
-Contoh penggunaan,
+Maka akan mencetak definisi dari kata "kamus" dan "bahasa" ke layar,
----
-$ kbbi bahasa
-=== bahasa :
- Definisi 1: sistem lambang bunyi yang arbitrer, yang digunakan oleh anggota suatu masyarakat untuk bekerja sama, berinteraksi, dan mengidentifikasikan diri
+=== bahasa
+ Definisi #1: sistem lambang bunyi yang arbitrer, yang digunakan oleh
+ anggota suatu masyarakat untuk bekerja sama, berinteraksi, dan
+ mengidentifikasikan diri
Kelas #1: Nomina: kata benda
Kelas #2: Linguistik: -
- Definisi 2: percakapan (perkataan) yang baik; tingkah laku yang baik; sopan santun
+ Definisi #2: percakapan (perkataan) yang baik; tingkah laku yang baik; sopan santun
Kelas #1: Nomina: kata benda
Contoh #1: baik budi --nya
- Definisi 3: sistem kata atau simbol yang memungkinkan untuk berkomunikasi dengan komputer, terutama untuk memasukkan instruksi-instruksi komputer melalui kata-kata yang mudah dipahami, dan kemudian diterjemahkan ke dalam kode mesin
+ ...
+
+=== kamus
+ Definisi #1: karya rujukan atau acuan dalam bentuk cetak maupun digital yang
+ memuat kata dan ungkapan, dapat disusun menurut abjad atau tema, berisi
+ keterangan tentang makna, pemakaian, atau terjemahan
+ Kelas #1: Nomina: kata benda
+
+ Definisi #2: buku yang memuat kumpulan istilah atau nama yang disusun
+ menurut abjad beserta penjelasan tentang makna dan pemakaiannya
Kelas #1: Nomina: kata benda
- Kelas #2: Komputer: -
+
+ ...
+----
+
+Unduh program KBBI untuk sistem operasi Anda,
+
+* https://kilabit.info/project/kbbi/bin/kbbi-linux-amd64.gz[Linux 64bit]
+* https://kilabit.info/project/kbbi/bin/kbbi-darwin-amd64.gz[macOS 64bit]
+* https://kilabit.info/project/kbbi/bin/kbbi-windows-amd64.gz[Windows 64bit]
+
+
+== Bot Telegram
+
+Dengan tersedianya API, membuka banyak implementasi terbuka lain, salah
+satunya yaitu Bot untuk aplikasi Telegram: https://t.me/KamuskuBot
+
+Untuk saat ini, KamuskuBot hanya punya satu perintah yaitu "/definisi". Cara
+menggunakan perintah ini hampir sama dengan program kbbi yaitu dengan
+memberikan kata yang dicari, contohnya,
+
----
+/definisi kamus,bahasa
+----
+
+
+== KBBI API
+
+KBBI API adalah jantung dari semua implementasi di atas dan pencarian definisi
+kata di bawah. KBBI API dapat diakses menggunakan HTTP lewat URL berikut:
+https://kilabit.info/project/kbbi/api
+
+
+=== API Definisi
+
+HTTP API untuk mencari definisi dari satu atau lebih kata.
+
+Format permintaan,
+
+----
+GET /definisi?kata=<string>,...
+----
+
+Format respons dalam JSON,
+
+----
+{
+ "<string>": {
+ "dasar": "<string>",
+ "definisi": [{
+ "isi": "<string>",
+ "kelas": [<string>],
+ "contoh": [<string>]
+ },
+ ...
+ ]
+ }
+}
+----
+
+Berikut contoh pemanggilan API untuk mencari definisi dari kata "kamus" dan
+"bahasa",
+
+https://kilabit.info/project/kbbi/api/definisi?kata=kamus,bahasa
-Untuk setiap kata dalam argumen tersebut akan dicetak dengan prefiks "==="
-kemudian diikuti oleh satu atau lebih kelas kata dan contoh penggunaan dari
-kata tersebut.
+Sekian, selamat meretas!
diff --git a/_www-kbbi/index.html b/_www-kbbi/index.html
index 4fc9edd..e665e86 100644
--- a/_www-kbbi/index.html
+++ b/_www-kbbi/index.html
@@ -17,6 +17,7 @@
margin: 0px auto;
width: 800px;
padding: 0px;
+ line-height: 1.25em;
}
h2 {
border-bottom: 1px solid silver;
@@ -31,6 +32,7 @@
color: black;
padding: 1.25em;
border-radius: 5px;
+ line-height: 1em;
}
.topbar {
background: aliceblue;
@@ -106,8 +108,18 @@
</div>
</div>
<p>
- Proyek implementasi antar-muka perintah dan API untuk Kamus Besar
- Bahasa Indonesia.
+ Proyek sumber terbuka implementasi antar-muka perintah dan API
+ untuk Kamus Besar Bahasa Indonesia.
+ </p>
+ <p>
+ Sumber kode untuk proyek ini dapat diambil di
+ <a
+ href="https://github.com/shuLhan/kbbi"
+ target="_blank"
+ title="Sumber kode KBBI di Github"
+ >
+ tautan berikut
+ </a>
</p>
<h2>Program kbbi</h2>
@@ -120,11 +132,12 @@
memberikan kata yang dicari setelah nama program, misalnya,
</p>
<pre>
-$ kbbi bahasa
+$ kbbi kamus,bahasa
</pre
>
<p>
- maka akan mencetak definisi dari kata "bahasa" ke layar,
+ maka akan mencetak definisi dari kata "kamus" dan "bahasa" ke
+ layar,
</p>
<pre>
=== bahasa
@@ -139,6 +152,15 @@ $ kbbi bahasa
Contoh #1: baik budi --nya
...
+
+=== kamus
+ Definisi #1: karya rujukan atau acuan dalam bentuk cetak maupun digital yang memuat kata dan ungkapan, dapat disusun menurut abjad atau tema, berisi keterangan tentang makna, pemakaian, atau terjemahan
+ Kelas #1: Nomina: kata benda
+
+ Definisi #2: buku yang memuat kumpulan istilah atau nama yang disusun menurut abjad beserta penjelasan tentang makna dan pemakaiannya
+ Kelas #1: Nomina: kata benda
+
+ ...
</pre
>
@@ -173,14 +195,70 @@ $ kbbi bahasa
</a>
</div>
+ <h2>Bot Telegram</h2>
+
<p>
- Sumber kode dapat diunduh di
+ Dengan tersedianya API, membuka banyak implementasi terbuka lain,
+ salah satunya yaitu Bot untuk aplikasi Telegram:
+ <a href="https://t.me/KamuskuBot" target="_blank">
+ https://t.me/KamuskuBot
+ </a>
+ </p>
+ <p>
+ Untuk saat ini, KamuskuBot hanya punya satu perintah yaitu
+ "/definisi". Cara menggunakan perintah ini hampir sama dengan
+ program kbbi yaitu dengan memberikan kata yang dicari, contohnya,
+ </p>
+ <pre>
+/definisi kamus,bahasa
+</pre
+ >
+
+ <h2>KBBI API</h2>
+
+ <p>
+ KBBI API adalah jantung dari semua implementasi di atas dan
+ pencarian definisi kata di bawah. KBBI API dapat diakses
+ menggunakan HTTP lewat: https://kilabit.info/project/kbbi/api.
+ </p>
+
+ <h3>API Definisi</h3>
+ <p>HTTP API untuk mencari definisi dari satu atau lebih kata.</p>
+ <p>
+ Format permintaan,
+ </p>
+ <pre>
+GET /definisi?kata=&lt;string&gt;,...
+</pre
+ >
+
+ <p>
+ Format respons dalam JSON,
+ </p>
+ <pre>
+{
+ "&lt;string&gt;": {
+ "dasar": "&lt;string&gt;",
+ "definisi": [{
+ "isi": "&lt;string&gt;",
+ "kelas": [&lt;string&gt;],
+ "contoh": [&lt;string&gt;]
+ },
+ ...
+ ]
+ }
+}
+ </pre
+ >
+
+ <p>
+ Berikut contoh pemanggilan API untuk mencari definisi dari kata
+ "kamus" dan "bahasa",
<a
- href="https://github.com/shuLhan/kbbi"
+ href="https://kilabit.info/project/kbbi/api/definisi?kata=kamus,bahasa"
target="_blank"
- title="Sumber kode KBBI di Github"
>
- tautan berikut
+ /definisi?kata=kamus,bahasa
</a>
</p>