Updated readme

This commit is contained in:
Gregorio Chiko Putra 2017-10-30 09:03:35 +07:00
parent 531d0d5b5d
commit b527084d95

View File

@ -1,5 +1,4 @@
# Dokumentasi
---
Panduan penggunaan aplikasi.
*Catatan :*
@ -41,7 +40,7 @@ Terbagi menjadi 3 bagian, yaitu `navigasi`, `navigasi sekunder`, dan `konten`.
Pada `navigasi` terdapat logo *Live Info* pada bagian kiri, serta 4 tombol pada bagian kanan. Tombol-tombol tersebut adalah:
- *Dokumentasi*, membuka tab baru yang akan menampilkan halaman ini.
- *Kategori*, mengalihkan ke halaman untuk mengubah dan menambah kategori.
- *User*, mengalihkan ke halaman untuk menambah user baru.
- *User*, mengalihkan ke halaman untuk menambah user baru. Hanya user dengan hak `administrator` yang memiliki akses ke halaman ini.
- *Profil*, mengalihkan ke halaman untuk mengubah profil.
- *Keluar*, berfungsi jika user ingin `logout`.
@ -51,10 +50,12 @@ Bagian `navigasi sekunder` merupakan navigasi yang berfungsi untuk menyaring pen
- *Belum Aktif*, menampilkan semua pengumuman yang belum aktif.
- *Nonaktif*, menampilkan semua pengumuman yang tidak aktif (`expired`).
Bagian `konten` berisi daftar semua pengumuman yang telah dibuat (atau yang telah disaring melalui `navigasi sekunder`). Daftar ini ditampilkan dalam bentuk box/kotak yang terdiri dari 3 bagian, yaitu pada bagian atas merupakan informasi singkat tentang pengumuman tersebut (pembuat, tanggal dibuat, masa aktif, tanggal edit/ubah), lalu pada bagian tengah terdapat isi dari pengumuman tersebut, dan pada bagian bawah terdapat 2 tombol, yaitu:
Bagian `konten` berisi daftar semua pengumuman yang telah dibuat (atau yang telah disaring melalui `navigasi sekunder`). Daftar ini ditampilkan dalam bentuk box/kotak yang terdiri dari 3 bagian, yaitu pada bagian atas merupakan informasi singkat tentang pengumuman tersebut (pembuat, tanggal dibuat, kategori, masa aktif, tanggal edit/ubah), lalu pada bagian tengah terdapat isi dari pengumuman tersebut, dan pada bagian bawah terdapat 2 tombol, yaitu:
- *Ubah*, untuk mengubah pengumuman yang dipilih.
- *Aktifkan*/*Matikan*, mengaktifkan/menonaktifkan pengumuman yang dipilih.
> Jika pengumuman tidak aktif atau `expired` maka kedua tombol tersebut tidak tersedia, tetapi digantikan dengan tulisan yang menyatakan bahwa pengumuman tersebut tidak aktif).
> Hanya user yang membuat pengumuman tersebut yang dapat mengubah dan/atau mengaktifkan/menonaktifkan pengumuman tersebut, terkecuali `administrator` memiliki hak kepada semua pengumuman.
###### *Screenshot :*
![administratorpage](images/screenshots/administratorpage.jpg)
@ -106,7 +107,7 @@ Pada daftar kategori, user dapat memodifikasi sebuah kategori. Pada setiap kateg
- *Aktifkan*/*Matikan*, mengaktifkan/menonaktifkan kategori yang dipilih.
> Kategori yang tidak aktif tidak akan ditampilkan dalam pembuatan pengumuman baru.
> Jika terdapat pengumuman aktif yang dengan kategori yang dipilih, maka kategori tersebut tidak dapat dinonaktifkan.
> Jika terdapat pengumuman yang sedang aktif dengan kategori yang dipilih, maka kategori tersebut tidak dapat dinonaktifkan.
###### *Screenshot :*
![categorypage](images/screenshots/categorypage.jpg)
@ -131,7 +132,7 @@ Terbagi menjadi 2 bagian, yaitu `navigasi` dan `konten`.
Bagian `navigasi` sama seperti yang ada pada <a href="#administrator-page">**Administrator Page**</a>.
Pada bagian `konten` terdapat sebuah `form` untuk mendaftarkan user baru yang terdiri dari 3 data yang harus diisi, yaitu:
- *Nama Lengkap*, nama yang ditampilkan ke user lain.
- *Nama Lengkap*, nama dari user baru.
- *Username*, username yang digunakan pada saat `login`.
- *Password*, password yang digunakan pada saat `login`.