2018-03-02 13:13 GMT+01:00 Stefan Bodewig <bode...@apache.org>: > On 2018-03-02, Gintautas Grigelionis wrote: > > > 2018-03-02 9:54 GMT+01:00 Stefan Bodewig <bode...@apache.org>: > > >> On 2018-03-01, Stefan Bodewig wrote: > > >>>> On Thu, Mar 1, 2018 at 7:28 AM, Gintautas Grigelionis < > >>>> g.grigelio...@gmail.com> wrote: > > >>>>> I tried then to use the replacement tags as consistently as > >>>>> possible in such a large body of text, but I realised that we > >>>>> perhaps need a kind of a style guide. Would you like to discuss > >>>>> it? Where would it best fit in the source code tree? > > >>> I'm not convinced I want to have any kind of rules keep people from > >>> writing docs :-) > > >> This comment isn't fair and I should have known better, sorry. > > > I didn't even notice your remark, really :-) > > That's good. Sometimes I realize when I'm being a jerk as in this case, > often I don't (and I appreciate people telling me when that happens). > > > All I wanted to say, keeping things visually consistent helps > > understanding. So, my simple set of rules is: > > > - <var> is for attributes > > - <q> is for values > > - <code> is for shell variable names/property name/CLI options and > input > > (should change that to <kbd>, really) > > - <samp> is for everything else, like filenames etc > > Looks reasonable. >
I feel a need to put this as a note somewhere in the manual. Also, target attributes for hyperlinks must be reviewed, please see below for a snippet of my browser dev console log :-( Gintas Mixed Content: The page at '<URL>' was loaded over HTTPS, but requested an insecure resource '<URL>'. This content should also be served over HTTPS. ide.html:1 Mixed Content: The page at 'https://rawgit.com/apache/ ant/master/manual/index.html' was loaded over HTTPS, but requested an insecure resource 'http://jdee.sourceforge.net/'. This content should also be served over HTTPS. jdee.sourceforge.net/:8 Mixed Content: The page at ' https://rawgit.com/apache/ant/master/manual/index.html' was loaded over HTTPS, but requested an insecure resource 'http://jdee.sourceforge.net/ toc.html'. This content should also be served over HTTPS. jdee.sourceforge.net/:9 Mixed Content: The page at ' https://rawgit.com/apache/ant/master/manual/index.html' was loaded over HTTPS, but requested an insecure resource 'http://jdee.sourceforge.net/ rootpage.html'. This content should also be served over HTTPS. ide.html:1 Mixed Content: The page at 'https://rawgit.com/apache/ ant/master/manual/index.html' was loaded over HTTPS, but requested an insecure resource 'http://ant.netbeans.org/'. This content should also be served over HTTPS. ide.html:1 Mixed Content: The page at 'https://rawgit.com/apache/ ant/master/manual/index.html' was loaded over HTTPS, but requested an insecure resource 'http://ant.netbeans.org/'. This content should also be served over HTTPS. jdee.sourceforge.net/toc.html:63 Mixed Content: The page at ' https://rawgit.com/apache/ant/master/manual/index.html' was loaded over HTTPS, but requested an insecure image 'http://jdee.sourceforge.net/ images/scoutsel.gif'. This content should also be served over HTTPS. jdee.sourceforge.net/rootpage.html:17 Mixed Content: The page at ' https://rawgit.com/apache/ant/master/manual/index.html' was loaded over HTTPS, but requested an insecure image 'http://jdee.sourceforge.net/ images/jdelogo.gif'. This content should also be served over HTTPS. index.html:1 Refused to display 'https://www.jetbrains.com/idea/' in a frame because it set 'X-Frame-Options' to 'deny'. netbeans.org/projects/ant/ Failed to load resource: the server responded with a status of 404 (Not Found) data:,:1 Refused to display 'https://netbeans.org/projects/ant/' in a frame because an ancestor violates the following Content Security Policy directive: "frame-ancestors 'self'". netbeans.org/projects/ant/ Failed to load resource: the server responded with a status of 404 (Not Found) data:,:1 Refused to display 'https://netbeans.org/projects/ant/' in a frame because an ancestor violates the following Content Security Policy directive: "frame-ancestors 'self'". www.ibm.com/developerworks/offers/wsad2.html:1 Refused to apply style from ' https://www.ibm.com/us-en/' because its MIME type ('text/html') is not a supported stylesheet MIME type, and strict MIME checking is enabled.
