1.3. External links to source code documentation¶
Both the Developer and User Guides contain external web-links to source code documentation relevant to the software being discussed (e.g. Javadoc). These are highlighted in the text using the following formatting:
Diamond Confluence - web-link ending with Confluence favicon, e.g. Data Acquisition Home
Gerrit - web-link ending with Gerrit favicon, e.g. gda-documentation
GitHub - web-link ending with GitHub cat, e.g. DawnScience/dawnsci
Javadoc - web-link ending with Java coffee-cup, e.g. Scannable
SourceForge - web-link ending with external arrow icon, e.g. EpicsResources
The formatting of the above links is provided by CSS code and uses the contents
of the web-link to determine whether the specific formatting is to be applied,
e.g. the Javadoc formatting is applied to all web-links that contain the text
javadocs
. In addition to the image, for all but Diamond Confluence links,
the link text is formatted using a monospace font, in blue and underlined.
Therefore the documentation writer should not apply any
formatting to the text of the link other than use of bold, italics,
or other formatting that will not obscure the formatting provided by the
CSS code (e.g. use of monospace
to format the code of the
link text will obscure the underline).
The custom CSS code is contained in the file
gda-documentation/common/_static/cutom.css
, for more information regarding
this see Use of custom CSS.
Icons used for GitHub, Javadoc and SourceForge links obtained from icons8.com.