diff --git a/doc/index.docbook b/doc/index.docbook index 640faf0..c8b4ad8 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1,277 +1,237 @@ -Cirkuit"> - - ]> The &cirkuit; Handbook Matteo Agostinelli agostinelli@gmail.com 2011 Matteo Agostinelli &FDLNotice; 2011-09-12 0.1 &cirkuit; is an application to produce high-quality publication-ready graphics. It provides a uniform interface to various graphics description languages. As of today, the supported languages are Circuit Macros, TikZ, PSTricks and Gnuplot. KDE graphics TikZ plot publication Introduction &cirkuit; is an application that provides a &kde; interface to various tools used for the production of publication-ready graphics. The main feature of &cirkuit; is to provide a live preview of the code the user enters to produce a plot. It is probably worth noting that &cirkuit; is not a point-and-click editor (like xfig for example), but instead the user is required to provide code to produce an output. Using &cirkuit; Screenshot: Here is a screenshot of &cirkuit;, showing a typical use-case scenario. Screenshot &cirkuit; features Quick preview of the code to speed up the production of your graphics. Optional automatic generation of the preview when the code has changed. Zoomable preview to allow fine-tuning in specific areas. Output is exportable to many popular graphics formats (PDF, EPS, SVG, PNG, JPG). Full LaTeX support for the labels. Powerful text editor (using &kate; part), which allows line numbering, VI mode, and much more. Inspectable log to debug the code describing the graphics. Editable templates to customize the build process. Easy plugin-based structure to allow different backends to be added. This means that several description languages can be supported, but with a unified interface. GetHotNewStuff integration to allow example graphics to be downloaded (or uploaded.) Syntax highlighting. The &cirkuit; backends &cirkuit; offers you several choices for the backends you wish to use with it, providing a unified interface to produce graphics. In general, each backend supports a different graphics description language, allowing the user to employ his favourite tools. Currently the following backends are available: Circuit Macros: Circuit Macros is a set of macros for drawing high-quality line diagrams. Fundamental electric circuit elements and basic logic gates are included with several tools and examples of other types of diagrams. Elements can be scaled or drawn in any orientation and are easy to modify. The advantages and disadvantages of such a system are similar to those of TeX itself, which is macro-based and non-wysiwyg, with ordinary character input. &cirkuit; automatically downloads the macros from the Internet (if a working connection is detected) and configures it properly. The macros are installed in the user's home directory, typically $HOME/.kde/share/apps/cirkuit. Please check the requirements before using the backend. See the project homepage for more information. TikZ: PGF/TikZ is a tandem of languages for producing vector graphics from a geometric/algebraic description. PGF is a lower-level language, while TikZ is a set of higher-level macros that use PGF. The top-level PGF and TikZ commands are invoked as TeX macros, but in contrast with PSTricks, the PGF/TikZ graphics themselves are described in a language that resembles MetaPost. Credits and License &cirkuit; Program copyright 2011 Matteo Agostinelli matteo@agostinelli.me Documentation Copyright © 2011 Matteo Agostinelli matteo@agostinelli.me &underFDL; &underGPL; - -Installation - - -How to obtain &cirkuit; - -&install.intro.documentation; - - - - + Requirements -In order to successfully use &cirkuit;, you need &kde; 4 and a working LaTeX +In order to successfully use &cirkuit;, you need &kde-frameworks; and a working LaTeX distribution. The individual backends might have additional requirements. Here is a (partial) list of the default backends' requirements: Circuit Macros: To use the Circuit Macros backend, a PIC interpreter must be installed. At the moment, two interpreters are supported: Dpic (recommended) &GNU; pic, also known as gpic or simply pic Additionally, m4 and a working LaTeX distribution are required. - - - - - - -Compilation and Installation - -&install.compile.documentation; - - - - -Configuration - - - Depending on your system, you may need to adjust the paths to the - different applications used by &cirkuit;. - - - - &documentation.index;