aerothemeplasma/DOCUMENTATION.md

9.8 KiB
Executable file

AEROTHEMEPLASMA DOCUMENTATION

TABLE OF CONTENTS

  1. Introduction
  2. List of components
  3. Components to be implemented

Introduction

The purpose of this documentation is to provide a detailed explanation of elements that contribute to the look, feel and functionality of this project. Since this project features a large variety of components, ranging from simple themes to entire applications, documentation will be organized into multiple categories based on the language the component is written in (plasmoids, applications) or the standard that defines it (themes). Components will categorized in the following way:

To keep the documentation condensed and to prevent redundancy, components that don't require documentation or are out of scope for this project (as in, documentation exists elsewhere) will not be documented here:

  • Date and time (io.gitgud.wackyideas.digitalclocklite)
  • Show desktop (Aero) (io.gitgud.wackyideas.win7showdesktop)
  • Keyboard switcher (org.kde.plasma.keyboardlayout)
  • Look and Feel (Splash and Lock screen theme) (authui7)
  • KWin decoration theme (smod)
  • Plasma tooltip (DefaultToolTip.qml)
  • Wine theme (Windows Style Builder)
  • Color scheme (KDE's docs, Video guide)
  • Icon theme (Freedesktop specification)
  • Cursor theme (Freedesktop specification)
  • Sound theme (KDE system settings)
  • GTK2 theme (GTK2 theme details)
  • Kvantum theme* (Kvantum documentation)

*While Kvantum won't be discussed here, one important detail worth mentioning is that Kvantum does not respect KDE's color schemes for the most part and that this sometimes leads to unexpected visual results. Still, it's recommended to apply a KDE color scheme alongside Kvantum for maximum compatibility.

In the future, some components might receive their dedicated documentation, in case it's required.

List of components

This is a list of components that are included in this project, as well as their completion status. Note that finished components are still subject to bugs, general enhancements and maintenance, but they are "more or less" feature complete. The forked column links to the original projects and their authors. Please consider taking a look at their work, because without them, this project would not be possible.

Plasmoids

Name Description System Finished Fork
DigitalClockLite Seven Displays a calendar, time, events and holidays. N Y Intika
SevenStart An application launcher made to look like Windows 7's Start menu. N N adhe,
oKcerG,
SnoutBug
SevenTasks Task manager made to look like Windows 7's taskbar buttons. N N KDE
Show Desktop (Aero) Textured button that shows the desktop when clicked. Supports peeking. N Y Zren
DefaultToolTip.qml QML component used for displaying tooltips. Reduced padding and size. Y Y KDE
Desktop icons Improved desktop shell that reduces padding between icons. Y Y KDE
Keyboard layout switcher Textured button for switching layouts, with reduced size and better alignment. Y Y KDE
System tray Redesigned with reorganized placement, floating panels, hoverable icons and reduced size and padding. Y Y KDE

Themes

Name Description Finished Fork
Aero cursors Cursor pack for KDE. Currently supports resolutions 32 and 48. N Souris-2d07
SevenBlack Windows 7 theme for KDE Plasma. N Mirko Gennari,
DrGordBord,
bionegative
Sound collection Sounds taken from Windows 7 directly. Y Microsoft
VistaVG Wine theme Msstyle used for theming Wine applications. Y Vishal Gupta
Win2-7 Windows 7 theme for GTK2 applications. Adapted to work better with QGtkStyle. Y Juandejesuss
Windows 7 Kvantum Fixed certain padding and sizing issues, added more textures. Y DrGordBord
WindowsIcons Windows 8.1 icon pack adapted to fit KDE better while also changing certain icons to their Windows 7 counterparts. N B00merang team
SDDM theme SDDM session login theme. Y Souris-2d07

KWin

Name Description Finished Fork
Reflection Effect KWin Effect that renders a glassy texture under windows. N KDE
Firefox Blur Region Fix KWin Effect that fixes Firefox's transparency and allows it to have proper blur and reflections. N N/A
SMOD KWin decoration theme based on Breeze, has support for removing inner window borders to mimic Windows 7's extended borders feature. N Souris-2d07
SMOD Button glow KWin effect that provides proper caption button glow Y Souris-2d07
Thumbnail Seven KWin task switcher that mostly replicates the look and behavior of Windows 7's task switcher N KDE

Miscellaneous

Name Description Finished Fork
Authui7 Aero themed login splash and lock screen. Y dominichayesferen
Install script Installation script for AeroThemePlasma. N N/A

Deprecated

Name Description Finished Fork
Smaragd Seven KWin decoration theme which uses Emerald themes as a basis, with some Aero specific changes and bugfixes. Lacks HiDPI support. N KDE
Aero Emerald Custom, non-standard Emerald theme made to work with Smaragd Seven. Features caption buttons that match the default sizes for both 7 and Vista. Y nicu96, Souris-2d07

Components to be implemented

These components are listed from highest priority to lowest priority.

  • Qt visual style to closely replicate the native Windows GUI appearance (Like QWindowsVistaStyle, or a fork of Kvantum)
  • Proper sound theme (upcoming in KDE Plasma 6)
  • Better folder thumbnailer plugin
  • Plymouth theme(?)