ceph/src/boost/tools/quickbook/doc/editors.qbk

   1 [/
   2     Copyright 2002,2004,2006 Joel de Guzman, Eric Niebler
   3     Copyright 2010-2011 Daniel James
   4
   5     Distributed under the Boost Software License, Version 1.0.
   6     (See accompanying file LICENSE_1_0.txt or copy at
   7     http://www.boost.org/LICENSE_1_0.txt)
   8 ]
   9
  10 [chapter Editor Support
  11     [quickbook 1.6]
  12     [compatibility-mode 1.5]
  13     [id quickbook.editors]
  14     [source-mode teletype]
  15 ]
  16
  17 Editing quickbook files is usually done with text editors both simple and
  18 powerful. The following sections list the settings for some editors which can
  19 help make editing quickbook files a bit easier.
  20
  21 [note You may submit your settings, tips, and suggestions to the
  22 authors, or through the [@https://lists.sourceforge.net/lists/listinfo/boost-
  23 docs Boost Docs mailing list].]
  24
  25 [section:scite Scintilla Text Editor]
  26
  27 [:['Section contributed by Dean Michael Berris]]
  28
  29 The Scintilla Text Editor (SciTE) is a free source code editor for Win32 and X.
  30 It uses the SCIntilla source code editing component.
  31
  32 [tip SciTE can be downloaded from [@http://www.scintilla.org/SciTE.html]]
  33
  34 You can use the following settings to highlight quickbook tags when
  35 editing quickbook files.
  36
  37 ```
  38 qbk=*.qbk
  39 lexer.*.qbk=props
  40 use.tabs.$(qbk)=0
  41 tab.size.$(qbk)=4
  42 indent.size.$(qbk)=4
  43 style.props.32=$(font.base)
  44 comment.stream.start.props=[/
  45 comment.stream.end.props=]
  46 comment.box.start.props=[/
  47 comment.box.middle.props=
  48 comment.box.end.props=]
  49 ```
  50
  51 [note Thanks to Rene Rivera for the above SciTE settings.]
  52
  53 [endsect] [/scite]
  54
  55 [/ KDE support (Kate, KWrite, Konqueror, KDevelop) ]
  56 [include ../extra/katepart/katepart.qbk]