diff --git a/docs/contents.rst b/docs/contents.rst index a1d15892f2..d97a668d11 100644 --- a/docs/contents.rst +++ b/docs/contents.rst @@ -15,8 +15,6 @@ Mayan EDMS documentation contents intro/index topics/index releases/index - topics/settings - topics/development credits/index faq/index diff --git a/docs/index.rst b/docs/index.rst index b13a2291a4..c7ffad1fde 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -61,7 +61,7 @@ Between versions Customization and fine tunning ============================== - :doc:`Settings ` + :doc:`Settings ` | :doc:`Customization ` For developers diff --git a/docs/topics/customization.rst b/docs/topics/customization.rst new file mode 100644 index 0000000000..d02c96a485 --- /dev/null +++ b/docs/topics/customization.rst @@ -0,0 +1,35 @@ +============= +Customization +============= + +The general appearance of **Mayan EDMS** can be customized entirely just +by changing a few settings. + +**Mayan EDMS** uses `Andrea Franz's excellent web app template`_ which includes +several themes that could be used to adapt **Mayan EDMS**'s appearance to match +an organtization existing applications' look and feel. + +The theme can be changed very easily by settings the :setting:`WEB_THEME_THEME` +configuration option to one of its valid values. + +.. image:: themes.png + :alt: themes + +The amount of information presented at the login screen can also be restricted +if for security or desgin reasons using :setting:`WEB_THEME_VERBOSE_LOGIN` +configuration option. + +.. image:: mayan-login.png + :alt: mayan login screen + +Sometimes users just want to go directly to work and not just be greeted with +a home screen, for these kind of situations **Mayan EDMS** has the +:setting:`MAIN_DISABLE_HOME_VIEW` configuration option which will cause +users to land on their ``recent document list`` as soon as they log in. + +Some themes such as ``default`` might be more visually appealing to some +people without the menu icons, for this **Mayan EDMS** provides the +:setting:`MAIN_DISABLE_ICONS` configuration option. + +.. image:: no-icons.png + :alt: mayan screens with out icons diff --git a/docs/topics/index.rst b/docs/topics/index.rst index a97ff7d101..f650be46fc 100644 --- a/docs/topics/index.rst +++ b/docs/topics/index.rst @@ -16,3 +16,6 @@ Introductions to all the key parts of Mayan EDMS you'll need to know: indexes smart_links ocr + settings + customization + development diff --git a/docs/topics/mayan-login.png b/docs/topics/mayan-login.png new file mode 100644 index 0000000000..65673aa303 Binary files /dev/null and b/docs/topics/mayan-login.png differ diff --git a/docs/topics/no-icons.png b/docs/topics/no-icons.png new file mode 100644 index 0000000000..d00eec2d62 Binary files /dev/null and b/docs/topics/no-icons.png differ diff --git a/docs/topics/themes.png b/docs/topics/themes.png new file mode 100644 index 0000000000..47ef20d00d Binary files /dev/null and b/docs/topics/themes.png differ