style_guide.rst ========================= OpenLP Manual Style Guide ========================= This Style Guide will be used to clarify how the manual is formated and is intended to keep all the pages in the manual consistent. Page Title ========== 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: -------- .. _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 unwelcome results. Pictures ======== All pictures will be in the .pmg 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. All pictures used in the page will be described at the end of the document and image pointers will be used inside the document when an image is to be displayed. The image deffinition uses upper case for the image title and the in line image link uses lower case for the image title. No spaces are to be 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 .. |DELETEICON| image:: pics/theme_delete.png In Page Example: -------------------- Click on the |deleteicon| Delete Icon to delete the Bible. end of examples On Screen Buttons ================= When instructing the user to use an on screen button, use the Gui label formated to make the button stand out. Gui Label Format :guilabel:`Next` Menu Paths ========== When describing a menu path, use the menu selection format. :menuselection:`File --> Import --> Bible` Referance Links For Headers =========================== 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: -------- .. _bibles_sublevel: Sublevel ======== end of example Terminal Commands ================= 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: mod2osis biblename > biblename.osis end of example Codeing ======= When entering coding use the wrap the coding inside two ` characters. Example: -------- ``