Skip to content

Commit

Permalink
Complete Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
raniaamina committed May 24, 2019
1 parent 17795fe commit 0a34817
Show file tree
Hide file tree
Showing 2 changed files with 294 additions and 5 deletions.
115 changes: 112 additions & 3 deletions README-ID.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
[EN Version](README.md)
# LibreOffice Theme Changer (LO-TC)

LibreOffice Theme Changer atau LO-TC (baca: Lotis) merupakan sebuah perkakas sederhana untuk membantu Anda mengubah tema pada LibreOffice versi 6.2 atau terbaru. LO-TC memungkinkan Anda untuk mengganti gambar splash dan tema persona pada LibreOffice dengan gambar yang Anda inginkan dengan sangat mudah.
Expand All @@ -22,7 +23,7 @@ Langkah selanjutnya, adalah menentukan tema yang ingin dipasang. Daftar tema yan

Untuk memasang tema, Anda diharuskan memiliki akses root. Anda akan diminta untuk memasukkan sandi root setelah Anda menentukan tema yang akan dipasang. Selain itu, pastikan pula bahwa aplikasi LibreOffice tidak sedang digunakan/berjalan.

Setelah pemasangan selesai, Anda dapat memlih apakah akan langsung menerapkan tema terpilih atau tidak. Anda dapat mengaktifkan tema secara manual melalui menu `perkakas` --> `Opsi`--> Personalisasi. Perhatikan gambar berikut.
Setelah pemasangan selesai, Anda dapat memlih apakah akan langsung menerapkan tema terpilih atau tidak. Anda dapat mengaktifkan tema secara manual melalui menu `perkakas` --> `Opsi`--> `Personalisasi`. Perhatikan gambar berikut.

![Aktivasi Manual](img/img-5.png)

Expand All @@ -35,7 +36,7 @@ Untuk saat ini LO-TC dapat berjalan baik pada distribusi Debian, openSUSE, Fedor

## Manghapus Tema LO-TC

Untuk mengahus tema via LO-TC cukup jalankan perintah
Untuk mengahpus tema via LO-TC cukup jalankan perintah

```bash
$ bash uninstall.sh
Expand All @@ -45,4 +46,112 @@ kemudian pilih tema yang ingin dihapus.

## Membuat Tema Kustom untuk LO-TC

Berikut langkah-langkah untuk membuat tema LibreOffice. Hal-hal yang akan dibuat antara lain splash dan tema persona.
Berikut langkah-langkah yang dapat Anda ikuti untuk membuat tema kustom LibreOffice.


### Hirarki Folder Tema

LO-TC menyusun konfigurasi tema dalam sebuah hirarki folder khusus agar mempermudah siapa saja yang ingin membuat kustom tema dan memasangnya menggunakan LO-TC. Simpan dan tempatkan masing-masing aset yang nantinya akan dibuat ke dalam direktori **themes**. LO-TC akan secara otomatis membaca daftar tema yang terdapat pada direktori, kami menyebutnya tema siap pasang.

silakan perhatikan hirarki direktori berikut ini untuk membantu Anda mengetahui di mana lokasi penyimpanan aset-aset yang akan Anda buat pada langkah-langkah selanjutnya.

```bash
themes
└── nama-tema
├── program
│   ├── intro.png
│   └── sofficerc
├── screenshot.png
└── share
└── gallery
└── personas
├── nama-tema
│   ├── footer.png
│   ├── header.png
│   └── preview.png
└── personas_list.txt

```

### Menyiapkan Aset-Aset Gambar

Gambar-gambar yang harus dipersiapkan untuk membuat tema ini antara lain:

1. Splash
Splash merupakan gambar yang pertama kali muncul ketika Anda menjalankan LibreOffice. Sebenarnya tak ada ukurab baku untuk gambar splash ini, namun kami sarankan untuk menggunakan ukuran yang juga digunakan oleh LibreOffice yaitu 661 x 169 piksel. Anda dapat membuat splash menggunakan template yang sudah kami sediakan. Silakan unduh melalui [tautan ini](template/intro.svg)

2. Header
Header merupakan gambar yang tampak pada bagian atas program LibreOffice, tepatnya di area menu LibreOffice. Standar ukuran header ini kami ambil dari standar ukuran aset gambar pada tema-tema persona. Kami sangat menyarankan agar desain yang dibuat untuk header ini memanfaatkan area pojok kanan atas. Alasan teknisnya adalah karena area ini merupakan area palinga aman dan tidak mengganggu visibilitas ikon-ikon pada menu. Kami telah menyiapkan template header yang siap untuk dimodifikasi. Silakan unduh melalui [tautan ini](template/header.svg)

3. Footer
Footer merupakan gambar yang akan tampil pada area bawah program LibreOffice. Pada dasarnya footer ini akan tersembunyi secara otomatis apabila tidak ada menu yang terbuka pada bagian bawah/footer LibreOffice. Area aman untuk footer ini berada di sisi kanan, silakan gunakan template yang telah kami sediakan untuk memabantu Anda membuat footer. Template dapat [diunduh di sini](template/footer.svg)

4. Preview
Preview merupakan gambar yang akan ditampilkan pada menu `perkakas` --> `Opsi`--> `Personalisasi`. Preview ini menjadi identitas tema Anda. Area aman untuk gambar preview ini berada di bagian tengah are. Silakan untuh template preview yang telah kami sediakan [melalui tautan ini](template/preview.svg)

5. Screenshot (opsinal)
Bantu para pengguna lain untuk memngenali tema Anda dengan memberikan screenshot ketika tema Anda berhasil terpasang.

### Membuat Konfigurasi

Setelah Anda menyiapkan aset-aset gambar, sekarang mari menyiapkan berkas-berkas konfogurasi. Berikut adalah beberapa berkas konfigurasi yang akan kita kita siap:

1. sofficerc
`sofficerc` merupakan berkas yang akan mengatur bagaimana splash akan ditampilkan. Berikut merupakan isi dari berkas sofficerc dan beberapa penjelasannya.
```bash
[Bootstrap]
CrashDirectory=${$BRAND_BASE_DIR/program/bootstraprc:UserInstallation}/crash
HideEula=1
Logo=1
NativeProgress=false
ProgressBarColor=0,0,0
ProgressFrameColor=102,102,102
ProgressPosition=35,153
ProgressSize=444,8
ProgressTextBaseline=145
ProgressTextColor=0,0,0
SecureUserConfig=true
SecureUserConfigCompress=true
SecureUserConfigExtensions=true
SecureUserConfigMode=1
SecureUserConfigNumCopies=2
URE_BOOTSTRAP=${ORIGIN}/fundamentalrc
```
untuk melakukan kustomsisasi tampilan Anda hanya perlu menyunting parameter, `logo`, `NativeProgress`, `ProgressBarColor`, `ProgressFrameColor`, `ProgressPosition`, dan `ProgressSize`
- Logo -- parameter untuk menentukan apakah splash ditampilkan atau tidak
- NativeProgress -- Menampilkan *progressbar* native atau kustom
- ProgressBarColor -- Menentukan warna *progressbar*, parameter ini menggunakan nilai warna RGB
- ProgressFrameColor -- Menentukan warna bingkai pada *progressbar*, parameter ini menggunakan nilai warna RGB
- ProgressPosition -- Menentukan lokasi *progressbar*, parameter ini menggunakan nilai koordinat X dan Y
- ProgressSize -- Menentukan ukutan dari *progressbar*, parameter ini menggunakan nilai lebar dan tinggi dengan satuan piksel

2. persona_list.txt
`persona_list.txt` merupakan berkas konfigurasi untuk mengatur bagaimana tema kita akan ditampilkan. Berkas terserbut memuat informasi sebagai berikut:
- Nama Direktori Tema
- Nama Tema (akan muncul sebagai tooltip)
- Lokasi berkas preview
- Lokasi berkas header
- Lokasi berkas footer
- Warna backgrond dan foreground

Berikut merupakan contoh format penulisan informasi di atas (misalnya tema yang dibuat bernama ***rainbow***).
```bash
rainbow;Rainbow;rainbow/preview.png;rainbow/header.png;rainbow/footer.png;;#ffffff;#000000
```

Setelah semua aset dan berkas konfigurasi siap, silakan jalankan LO-TC, jika langkah-langkah yang dilakukan benar, seharusnya tema Anda akan muncul sebagai daftar tema yang siap pakai.

## Berkontribusi

Tertarik untuk meningkatkan fitur pada LO-TC ini? Tertarik untuk membantu kami memperkaya koleksi tema untuk LO-TC, silakan ajukan Pull Request pada repositori ini.

## Penyangkalan

Perkakas ini masih dalam tahap pengembangan sehingga pastikan Anda memahami bahwa setiap risiko yang ditimbulkan dari perangkat ini sepenuhnya ditanggung oleh pengguna, hehe.

## Inisiator

Perkakas LibreOffice Theme Changer (LO-TC) ini diinisiasi oleh:
- [Rania Amina](https://github.com/raniaamina)
- [Sofyan Sugiyanto](https://github.com/artemtech)
- [LibreOffice Indonesia](https://libreoffice.id)
184 changes: 182 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,183 @@
# LO-TC
[Versi Bahasa Indonesia](README-ID.md)
# LibreOffice Theme Changer (LO-TC)

LibreOffice Theme Changer or LO-TC (read: Lotis) is a simple tool to help you change themes in LibreOffice version 6.2 (or newer). LO-TC allows you to easily replace default splash images and persona themes on LibreOffice with your own image.

## Installing Themes Via LO-TC

We provide several themes that you can choose and use directly, but you can also add your own themes that you want. Step by step how to create own them will provided in the next section.

To run LO-TC, please follow the following steps. Make sure Git is installed on your operating system.

```bash
$ git clone https://github.com/raniaamina/libreoffice-theme.git
$ cd libreoffice-theme
$ bash install.sh
```

![Selecting the Installation Method](img/img-1.png)

LibreOffice supports many installation methods, each method has its own directory for storing LibreOffice configuration files. For that case, please choose the appropriate installation method so the theme can be installed correctly.

The next step, is to determine the theme you want to install. A list of available themes can be seen in the `themes` directory.

![Select Theme](img/img-2.png)

To install a theme, you are required to have root access. You will be asked to enter the root password after you choose your prefered theme to be installed. Bside of that, make sure that the LibreOffice application is not being used/running.

After the installation is complete, you can choose whether to immediately apply the selected theme or not. You can activate the theme manually through menu `tool` -> `Options`->`Personalization` in LibreOffice. Look at the following picture.

![Manual Activation](img/img-5.png)


> **SPECIAL NOTE**
> For now the LO-TC can run well on the Debian, openSUSE, Fedora, Ubuntu, and derivative distributions. For distros other than those mentioned, they must enter the LibreOffice path manually. Consider the following picture.
>![Manually Enter Path](img/img-6.png)
## Remove the LO-TC Theme

To remove theme via LO-TC just run the command

```bash
$ bash uninstall.sh
```

then select the theme you want to delete.

## Create a Custom Theme for LO-TC

Please follow this steps to create a custom LibreOffice theme.


### Understanding Disrectory Themes Hierarchy

The LO-TC use special directory hierarchy to make it easier for anyone who wants to create a custom theme and install it using LO-TC. Save and place each assets that will be created in the **themes** directory. LO-TC will automatically read the list of themes contained in the directory, we call them preinstalled themes.

please pay attention to the following directory hierarchy to help you find out where the assets are stored in the next steps.

```bash
themes
└── your-theme
├── program
│   ├── intro.png
│   └── sofficerc
├── screenshot.png
└── share
└── gallery
└── personas
├── your-theme
│   ├── footer.png
│   ├── header.png
│   └── preview.png
└── personas_list.txt

```
### Preparing Image Assets

The pictures that must be prepared to make this theme include:

1. Splash
Splash is the image that appears at the first time when you run LibreOffice. Actually there is no standard size for this splash image, but we recommend using the size that is also used by LibreOffice which is 661x169 pixels. You can make a splash using the template that we have provided.
[Download here](template/intro.svg)

2. Header
The header is an image that appears at the top of the LibreOffice program, precisely in the LibreOffice menu area. We use the header size from the standard image size assets on Firefox persona themes. We strongly recommend that the design created for this header take advantage of the upper right corner area. The technical reason is because this area is the most save area and does not interfere with the visibility of the icons on the menu. We have prepared a header template that is ready to be modified.
[Download Here](template/header.svg)

3. Footer
Footer is an image that will appear in the area under the LibreOffice program. Basically this footer will be hidden automatically if there is no menu open at the bottom/footer of LibreOffice. The safe area for this footer is on the right side, please use the template that we have provided to help you create a footer.
[Download Here](template/footer.svg)

4. Preview
Preview is an image that will be displayed in the `tool` menu -> `Options` -> `Personalization`. This preview becomes the identity of your theme. The safe area for this preview image is in the middle of the area. Please download the preview template that we have provided.
[Download Here](template/preview.svg)

5. Screenshot (optional)
Help other users recognize your theme by providing screenshots when your theme is successfully installed.

### Create Configuration Files

After you have set up image assets, let's now prepare configuration files. Here are some configuration files that we will prepare:

1. Sofficerc
`sofficerc` is a file that will set how the splash will be displayed. Here is the contents of the sofficerc file followed by simple explanations.
```bash
[Bootstrap]
CrashDirectory=${$BRAND_BASE_DIR/program/bootstraprc:UserInstallation}/crash
HideEula=1
Logo=1
NativeProgress=false
ProgressBarColor=0,0,0
ProgressFrameColor=102,102,102
ProgressPosition=35,153
ProgressSize=444,8
ProgressTextBaseline=145
ProgressTextColor=0,0,0
SecureUserConfig=true
SecureUserConfigCompress=true
SecureUserConfigExtensions=true
SecureUserConfigMode=1
SecureUserConfigNumCopies=2
URE_BOOTSTRAP=${ORIGIN}/fundamentalrc
```
to customize splash display you only need to edit parameters, `logo`,` NativeProgress`, `ProgressBarColor`,` ProgressFrameColor`, `ProgressPosition`, and `ProgressSize`
- Logo -- parameter to determine whether the splash is displayed or not
- NativeProgress -- Displays *progressbar* native or custom
- ProgressBarColor -- Specifies the color *progressbar*, this parameter uses RGB color values
- ProgressFrameColor -- Specifies the color of the frame at *progressbar*, this parameter uses an RGB color value
- ProgressPosition -- Determine location *progressbar*, this parameter uses X and Y coordinate values
- ProgressSize -- Specifies the size of *progressba*, this parameter uses a value of width and height in pixels

2. persona_list.txt
`persona_list.txt` is a configuration file to set how our theme will be displayed. The file contains the following information:
- Name of Theme Directory
- Theme Name (also will appear as a tooltip)
- Location of preview file
- Location of header file
- Location of the footer file
- Backgrond and foreground colors

Here is an example of the format for writing the information above (for example, a theme named ***rainbow***).
```bash
rainbow;Rainbow;rainbow/preview.png;rainbow/header.png;rainbow/footer.png;;#ffffff;#000000
```

After all the assets and configuration files are ready, please run the LO-TC, if the steps are done correctly, your theme should appear as a list of ready-to-use themes.

## Contributing

Interested in improving the features of this LO-TC? Interested in helping us enrich the collection of themes for LO-TC, please submit a Pull Request to this repository.

## Disclaimer

This tool is still in the development stage so use at your own risk :").

## Project Initiator

This LibreOffice Theme Changer (LO-TC) tool is initiated by:
- [Rania Amina](https://github.com/raniaamina)
- [Sofyan Sugiyanto](https://github.com/artemtech)
- [LibreOffice Indonesia](https://libreoffice.id)






















LibreOffice Theme Changer - Simple script to change your default theme on LibreOffice (for 6.2 or newer)

0 comments on commit 0a34817

Please sign in to comment.