diff --git a/style_guide.rst b/style_guide.rst index 8f91772..23166c7 100644 --- a/style_guide.rst +++ b/style_guide.rst @@ -13,28 +13,26 @@ Each page will begine with a link reference and a title. The link reference should be the same as the title except that it is all in lower case with no spaces. Titles are to be in Title Case. -Example: --------- +.. code-block:: rst -.. _bibles: + .. _bibles: + + ====== + Bibles + ====== -====== -Bibles -====== - -end example Line Length =========== -Each line of the document should be no longer than 80 charectors. While -the build system can wrap the text, lines longer than 80 charectors can cause +Each line of the document should be no longer than 120 charectors. While +the build system can wrap the text, lines longer than 120 charectors can cause unwelcome results. Pictures ======== -All pictures will be in the .pmg format and stored in the pics directory of +All pictures will be in the .png format and stored in the pics directory of the manual. If the pictures is for a specific page the filename will start with the page name and contain no spaces. @@ -46,18 +44,19 @@ used in the image deffinition title. The image deffinition title will start with the page name unless the image is used across pages. End of Page Example: --------------------- -.. pictures used in this page +.. code-block:: rst + + .. pictures used in this page -.. |DELETEICON| image:: pics/theme_delete.png + .. |DELETEICON| image:: pics/theme_delete.png In Page Example: --------------------- -Click on the |deleteicon| Delete Icon to delete the Bible. +.. code-block:: rst + + Click on the |deleteicon| Delete Icon to delete the Bible. -end of examples On Screen Buttons ================= @@ -81,15 +80,13 @@ All sublevel headers will have a referance link above the header. The referance link name will start with the page title and then the sublevel title. No spaces are allowed in the link reference. -Example: --------- +.. code-block:: rst + + .. _bibles_sublevel: + + Sublevel + ======== -.. _bibles_sublevel: - -Sublevel -======== - -end of example Terminal Commands ================= @@ -98,27 +95,23 @@ When telling the user to enter a command on the command prompt or in a terminal window, use a double colon and 1 blank line before what the user is to type. Add 1 blank line after the what the user is to type. -Example: --------- - -To convert a Bible using the command prompt in -Windows or a terminal in Linux or macOS you would type: - +.. code-block:: rst + + To convert a Bible using the command prompt in + Windows or a terminal in Linux or macOS you would type: + mod2osis biblename > biblename.osis -end of example Codeing ======= When entering coding use the wrap the coding inside two ` characters. -Example: --------- - - ``
`` - - end of example +.. code-block:: rst + + ``
`` + Toolbar Descriptions ==================== @@ -126,25 +119,20 @@ Toolbar Descriptions When describing the items in a toolbar with one line descriptions, use the toolbar formatting. -Example: --------- - -|image| image description:: - some description about the image. - -end of example - +.. code-block:: rst + + |image| image description:: + some description about the image. + When the toolbar items need more detail, or you are documenting a feature, then use an inline Icon with Icon name -Example: --------- - -Selecting the |biblelock| Lock icon locks and unlocks the search results. +.. code-block:: rst -This feature can be used to combine multiple search results into one ... + Selecting the |biblelock| Lock icon locks and unlocks the search results. + + This feature can be used to combine multiple search results into one ... -end of example End of File ===========