Style and arrow patch update + general review of API and Server handbooks.

- Updated trueos_style to current.
- Updated menuselection arrow replacement patch to current.
- Reviewed API reference guide:
  - Reviewed for :guilabel: additions.
  - Added missing trademark symbols.
- Update Server handbook:
  - Added missing trademaks.
  - Replaced outdated link.
  - Updated admonition boxes.
  - Added :guilabel: role where necessary.
  - Add more descriptive text of SysAdm and the goals of the project.
  - Updated code-boxes.
This commit is contained in:
Mrt134
2016-08-24 13:13:57 -04:00
parent 9ed043f0f5
commit cf4a485382
11 changed files with 106 additions and 101 deletions

View File

@@ -4,7 +4,7 @@ logs
****
The logs class is used to interact with the log files created by the
SysAdm server.
SysAdm server.
Every logs class request contains the following parameters:

View File

@@ -95,7 +95,7 @@ from sphinx.roles import _amp_re
def patched_menusel_role(typ, rawtext, text, lineno, inliner, options={}, content=[]):
text = utils.unescape(text)
if typ == 'menuselection':
text = text.replace('-->', u'\N{HEAVY WIDE-HEADED RIGHTWARDS ARROW}') # Here is the patch
text = text.replace('-->', u'\u2192') # Here is the patch
spans = _amp_re.split(text)

View File

@@ -21,7 +21,7 @@ Authentication
Once a websocket connection is made to the server, the client needs to
use the authentication class to authenticate itself to obtain access to
the sysadm service. Every authentication class request contains the
the SysAdm service. Every authentication class request contains the
following parameters:
+----------------+------------+---------------------------------------+
@@ -613,7 +613,7 @@ mind:
Server Subsystems
=================
The RPC namespace can be used to get information about SysAdm server
The RPC namespace can be used to get information about SysAdm server
subsystems. This namespace supports the following parameters:
+---------------------------------+---------------+------------------------------------------------------------------------------+
@@ -705,7 +705,7 @@ access the user has. This subsystem is used only by the server.
Identify Subsystem
------------------
To identify the type of SysAdm system, use :command:`identify`. Possible
To identify the type of SysAdm system, use :command:`identify`. Possible
identities are "server", "bridge", and "client," with all three system
types using this subsystem.

View File

@@ -3679,21 +3679,19 @@ code.menuselection,
.guilabel,
.menuselection{
background-color: #D5DDE2; /* saturate from ecf0f3 to be more visible/blue on screen. */
display: inline-block;
display: inline;
font-family:'Inconsolata', monospace;
font-size: 95%;
padding-right: 3px;
padding-left: 3px;
padding-top: 3px;
padding-bottom: 2px;
border-radius: 5px;
line-height: 80%;
overflow: hidden;
padding-bottom: 3px;
border-radius: 3px;
overflow: hidden;
}
code.kbd, .kbd {
border: thin solid #000;
border-radius: 2px;
font-weight: bold
font-weight: bold
}
code.file, .file {
border: hidden/*thin solid #999*/