git.sur5r.net Git - bacula/docs/blob - docs/manuals/en/main/STYLE

   1 TODO
   2
   3 maybe spell out "config" to "configuration" as appropriate
   4
   5 Use American versus British spelling
   6
   7 not critical, but for later consider cleaning out some use of
   8 "there" and rewrite to not be so passive.
   9
  10 make sure use of \elink shows URL in printed book
  11
  12 get rid of many references of "Red Hat" -- too platform specific?
  13
  14 remove references to names, like "Dan Langille shared ..."
  15 just put their names in credits for book
  16
  17 don't refer to very old software by specific version such as
  18 "Red Hat 7" or FreeBSD 4.9 because is too old to put in book. It may be
  19 relevant, but may be confusing. Maybe just remove the version number
  20 if applicable.
  21
  22 maybe fine, but discuss point-of-view: don't use personal "I" or
  23 possessive "my" unless that is consistent style for book.
  24
  25 replace "32 bit" and "64 bit" with "32-bit" and "64-bit" respectively.
  26 It seems like more popular style standard
  27
  28 be consistent with "Note" and "NOTE". maybe use tex header for this
  29
  30 get rid of redundant or noisy exclamation marks
  31
  32 style for "ctl-alt-del" and "ctl-d"? and be consisten with formatting
  33
  34 be consistent for case for ext3, ext2, EXT3, or EXT2.
  35
  36 fix spelling of "inspite" in source and in docs (maybe use "regardless
  37 in one place where I already changed to "in spite"
  38
  39 be consistent with software names, like postgres, postgresql, PostreSQL
  40 and others
  41
  42 instead of using whitehouse for examples, use example.org (as that is defined
  43 for that usage); also check other hostnames and maybe IPs and networks
  44
  45 use section numbers and cross reference by section number or page number
  46 no underlining in book (this is not the web :)
  47
  48 some big gaps between paragraphs or between section headers and paragraphs
  49 -- due to tex -- adjust as necessary to look nice
  50
  51 don't include the GPL and LGPL in book. This will save 19 (A4) pages.
  52 For 6x9 book this will save 30 pages. (Keep GFDL though.)
  53
  54 many index items are too long
  55
  56 appendices not listed as appendix
  57
  58 some how consolidate indexes into one? on 6x9, the indexes are over 30 pages
  59
  60 don't refer to some website without including URL also
  61 (such as "this FreeBSD Diary article")
  62
  63 get rid of (R) trademark symbols -- only use on first use; for example
  64 don't put on the RPM Packaging FAQ
  65
  66 split up very long paragraphs, such as "As mentioned above, you will need ..."
  67 (on my page 783).
  68
  69 use smaller font or split up long lines (especially from
  70 console output which is wider than printed page)
  71
  72 don't assume all BSD is "FreeBSD"
  73
  74 don't assume all "kernel" is Linux. If it is Linux, be clear.
  75