diff --git a/docs/img/layout/Materails_API.png b/docs/img/layout/Materails_API.png new file mode 100644 index 0000000..be98c0f Binary files /dev/null and b/docs/img/layout/Materails_API.png differ diff --git a/docs/source/usage/explorer.rst b/docs/source/usage/explorer.rst index 138eb06..aa87e23 100644 --- a/docs/source/usage/explorer.rst +++ b/docs/source/usage/explorer.rst @@ -10,16 +10,23 @@ By selecting the left menu of home tab, users can control the files. :scale: 40 % :align: center | -.. csv-table:: Left menu of home tab - :header: "No.", "Name", "explanation" - :widths: 10, 10, 35 +.. csv-table:: Item of left sidebar + :header: "Item", "Explanation" + :widths: 25, 35 - "1", "Recently Used", "lately user used or accessed projects list." - "2", "My Computer", "the folder list of root directory." - "3", "Calculating", "the state of calculation " - "4", "Searched", "the previous searching list" - "5", "Web", "the bookmarked website list" - "6", "Downloads", "Downloaded list" + "Recently Used", "The history which users used, is shown in center window." + "My Computer", "In the case of windows system, C drive (system drive) is shown in center window.In the case of Mac OS, users home directory is shown." + "My Projects", "The QE project which users saved, and Examples are shown in the center window." + "Calculating", "Calculating content shows the state of QE calculating." + "Web", "Bookmark list is saved. Google URL is set in the Web item from the begining." + "Downloads", "The files which users downloaded, are shown." + +| +Moreover, the items of center window is depicted by 4 types (List, Small Tiles, Medium Tiles and Large Tiles). + +.. image:: ../../img/layout/ShowingMethod.gif + :scale: 50 % + :align: center | Right click the mouse on the file explore, users can make directory. diff --git a/docs/source/usage/layout.rst b/docs/source/usage/layout.rst index d743fa4..9d4060c 100644 --- a/docs/source/usage/layout.rst +++ b/docs/source/usage/layout.rst @@ -1,72 +1,58 @@ Layout of Window ================ -This page explains the layout of BURAI platform, and summarizes its overview of each part -(top bar, main home tub, and left sidebar of home tab). +This page shows the initial window of BURAI as -Top bar -------- +Header bar +---------- -Top bar was built of two items. +Header bar has two items: -1. Trigger type menu. +1. Main menu. 2. Materials API -* Trigger type menu +* Main menu -Trigger type menu has eight items. Also > icon can open Trigger type menu. +Main menu, which is symbolized ">" icon, has eight items. .. image:: ../../img/layout/TriggerMenu.gif :scale: 50 % - :align: center + :align: left -.. csv-table:: Item of Trigger type menu - :header: "Item", "explanation" - :widths: 25, 35 +| +.. csv-table:: Items of main menu + :header: "Item", "Explanation" + :widths: 15, 35 - "About BURAI", "BURAI information, version, and license are shown." - "Documents", "BURAI manual is shown" - "Links (Web)", "Quantum ESPRESSO (QE) Home page and each QE solver page links are inclued." - "Path of QE", "Setting and Showing QE and MPI Path." - "Proxy server", "Setting proxy system." + "About BURAI", "BURAI information, where version and license are shown." + "Documents", "This documantation is shown." + "Links (Web)", "Some links (QE web page, psudopotential page ...)" + "Path of QE", "Set and Show QE and MPI paths." + "Proxy server", "Set proxy system." "Full screen", "BURAI windows size are changed full screen." - "Quit [Ctr +Q]", "BURAI platform are finished." + "Quit [Ctr + Q]", "Quit the system of BURAI." * Materials API -BURAI can get crystal structure by using `Materials API `_ . -Therefore, users have to enter element symbols into the bar of Materials API. -The detailed explanation is shown in Materials API content (add link). +You can get crystal structure through `Materials API `_. +| Please see `here `_ for the details. + +.. image:: ../../img/layout/Material_API.png + :scale: 50 % + :align: left Home tab -------- -Home tab is built from the left sidebar and center window. -Its left sidebar has seven items. In case users select item of left sidebar, -its item information is shown in center window. Thus, when user start BURAI platform, -the history of Recently Used content is shown in its center window. +Home tab, which is located under header bar, has explorer system. +| Please see `here `_ for the details of the explorer. .. image:: ../../img/layout/HomeTab.png :scale: 50 % - :align: center - -.. csv-table:: Item of left sidebar - :header: "Item", "explanation" - :widths: 25, 35 - - "Recently Used", "The history which users used, is shown in center window." - "My Computer", "In the case of windows system, C drive (system drive) is shown in center window.In the case of Mac OS, users home directory is shown." - "My Projects", "The QE project which users saved, and Examples are shown in the center window." - "Calculating", "Calculating content shows the state of QE calculating." - "Web", "Bookmark list is saved. Google URL is set in the Web item from the begining." - "Downloads", "The files which users downloaded, are shown." - -Moreover, the items of center window is depicted by 4 types (List, Small Tiles, Medium Tiles and Large Tiles). - -.. image:: ../../img/layout/ShowingMethod.gif - :scale: 50 % - :align: center + :align: left + +