diff options
Diffstat (limited to 'help')
| -rw-r--r-- | help/C/Makefile.am | 10 | ||||
| -rw-r--r-- | help/C/figures/oregano-main-window.png | bin | 0 -> 46841 bytes | |||
| -rw-r--r-- | help/C/legal.xml | 74 | ||||
| -rw-r--r-- | help/C/oregano-C.omf | 31 | ||||
| -rw-r--r-- | help/C/oregano.xml | 447 | ||||
| -rw-r--r-- | help/Makefile.am | 1 | ||||
| -rw-r--r-- | help/es/Makefile.am | 7 | ||||
| -rw-r--r-- | help/es/legal.xml | 74 | ||||
| -rw-r--r-- | help/es/oregano-es.omf | 31 | ||||
| -rw-r--r-- | help/es/oregano.xml | 96 | ||||
| -rw-r--r-- | help/fr/Makefile.am | 7 | ||||
| -rw-r--r-- | help/fr/legal.xml | 28 | ||||
| -rw-r--r-- | help/fr/oregano-fr.omf | 30 | ||||
| -rw-r--r-- | help/fr/oregano.xml | 137 |
14 files changed, 973 insertions, 0 deletions
diff --git a/help/C/Makefile.am b/help/C/Makefile.am new file mode 100644 index 0000000..3ca4fad --- /dev/null +++ b/help/C/Makefile.am @@ -0,0 +1,10 @@ +figdir = figures +docname = oregano +lang = C +omffile = oregano-C.omf +entities = legal.xml +include $(top_srcdir)/xmldocs.make +dist-hook: app-dist-hook + + + diff --git a/help/C/figures/oregano-main-window.png b/help/C/figures/oregano-main-window.png Binary files differnew file mode 100644 index 0000000..8d23806 --- /dev/null +++ b/help/C/figures/oregano-main-window.png diff --git a/help/C/legal.xml b/help/C/legal.xml new file mode 100644 index 0000000..70d0183 --- /dev/null +++ b/help/C/legal.xml @@ -0,0 +1,74 @@ +<legalnotice id="legalnotice"> + <para> + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation + License (GFDL), Version 1.1 or any later version published + by the Free Software Foundation with no Invariant Sections, + no Front-Cover Texts, and no Back-Cover Texts. You can find + a copy of the GFDL at this <ulink type="help" url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS + distributed with this manual. + </para> + <para> This manual is part of a collection of GNOME manuals + distributed under the GFDL. If you want to distribute this + manual separately from the collection, you can do so by + adding a copy of the license to the manual, as described in + section 6 of the license. + </para> + + <para> + Many of the names used by companies to distinguish their + products and services are claimed as trademarks. Where those + names appear in any GNOME documentation, and the members of + the GNOME Documentation Project are made aware of those + trademarks, then the names are in capital letters or initial + capital letters. + </para> + + <para> + DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED + UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE + WITH THE FURTHER UNDERSTANDING THAT: + + <orderedlist> + <listitem> + <para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS, + WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR + IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES + THAT THE DOCUMENT OR MODIFIED VERSION OF THE + DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR + A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE + RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE + OF THE DOCUMENT OR MODIFIED VERSION OF THE + DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR + MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, + YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY + CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY + SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER + OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS + LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED + VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER + EXCEPT UNDER THIS DISCLAIMER; AND + </para> + </listitem> + <listitem> + <para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL + THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), + CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, + INITIAL WRITER, ANY CONTRIBUTOR, OR ANY + DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION + OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH + PARTIES, BE LIABLE TO ANY PERSON FOR ANY + DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR + CONSEQUENTIAL DAMAGES OF ANY CHARACTER + INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS + OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR + MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR + LOSSES ARISING OUT OF OR RELATING TO USE OF THE + DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, + EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF + THE POSSIBILITY OF SUCH DAMAGES. + </para> + </listitem> + </orderedlist> + </para> + </legalnotice>
\ No newline at end of file diff --git a/help/C/oregano-C.omf b/help/C/oregano-C.omf new file mode 100644 index 0000000..b353465 --- /dev/null +++ b/help/C/oregano-C.omf @@ -0,0 +1,31 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE omf PUBLIC "-//OMF//DTD Scrollkeeper OMF Variant V1.0//EN" "http://scrollkeeper.sourceforge.net/dtds/scrollkeeper-omf-1.0/scrollkeeper-omf.dtd"> +<omf> + <resource> + <creator> + rmarkie@fi.uba.ar (Ricardo Markiewicz) + </creator> + <title> + Oregano User Guide + </title> + <date> + 2004-05-03 + </date> + <version identifier="0.0.3" date="2004-08-11" description="alpha version"/> + <subject category="GNOME|Core Desktop"/> + <description> + This document will describe the benefits of oregano 2, and show you + some examples. + </description> + <type> + manual + </type> + <format mime="text/xml" dtd="-//OASIS//DTD DocBook XML V4.1.2//EN"/> + <identifier url=""/> + <language code="C"/> + <relation seriesid="b57e7e48-be78-11d6-85a3-d094906a987c"/> + <rights type="GNU FDL" license.version="1.1" + license="http://www.gnu.org/licenses/fdl.html" holder="Havoc + Pennington, John Fleck"/> + </resource> +</omf> diff --git a/help/C/oregano.xml b/help/C/oregano.xml new file mode 100644 index 0000000..5d36977 --- /dev/null +++ b/help/C/oregano.xml @@ -0,0 +1,447 @@ +<?xml version="1.0"?> +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" + "/usr/share/xml/docbook/custom/mathml/1.0/dbmathml.dtd" + [ + <!ENTITY legal SYSTEM "legal.xml"> + <!ENTITY appversion "0.1"> + <!ENTITY manrevision "0.1"> + <!ENTITY date "15 November 2009"> + <!ENTITY app "<application>Oregano</application>"> +]> +<article id="index" lang="en"> + <articleinfo> + <title><application>Oregano</application> User's Guide</title> + <copyright> + <year>2009</year> + <holder>Marc Lorber</holder> + </copyright> + <copyright> + <year>2003</year><year>2004</year> + <holder>LUGFi</holder> + </copyright> + <copyright> + <year>1999</year><year>2001</year><year>2002</year> + <holder>Richard Hult</holder> + </copyright> + <publisher> + <publishername> LUGFI </publishername> + </publisher> + + <authorgroup> + <author> + <firstname>Marc</firstname> <surname>Lorber</surname> + <affiliation> + <address><email>Lorber.Marc@wanadoo.fr</email></address> + </affiliation> + </author><author> + <firstname>Ricardo</firstname> <surname>Markiewicz</surname> + <affiliation> + <address><email>rmarkie@fi.uba.ar</email></address> + </affiliation> + </author> + </authorgroup> + <revhistory> + <revision> + <revnumber>Oregano Manual V 0.1</revnumber> + <date>2009</date> + <revdescription> + <para role="author">Marc Lorber</para> + </revdescription> + </revision> + <revision> + <revnumber>Oregano Manual V 0</revnumber> + <date>2004</date> + <revdescription> + <para role="author">Ricardo Markiewicz</para> + </revdescription> + </revision> + </revhistory> + + <releaseinfo> + Oregano is a tool for schematic capture and simulation + of electronic circuits. It simplifes design of simple circuits + by letting the user draw the circuit and then simulate its + electrical characteristics. + + This document is mostly meant to be an introduction + for someone who already is familiar with circuit simulation + and wants to try out Oregano. + </releaseinfo> + <!-- An address can be added to the publisher information. If a role is + not specified, the publisher/author is the same for all versions of the + document. --> + + &legal; + <!-- This file contains link to license for the documentation (GNU FDL), and + other legal stuff such as "NO WARRANTY" statement. Please do not change + any of this. --> + + <legalnotice> + <title>Feedback</title> + <para>To report a bug or make a suggestion regarding the + <application>Oregano</application> application or + this manual, follow the directions in the <ulink + url="ghelp:oregano-feedback" type="help">Oregano Feedback Page</ulink>. + </para> + </legalnotice> + </articleinfo> + + + +<!-- ============= Document Body ============================= --> + + <sect1 id="Spice"> + <title><emphasis>Spice</emphasis>: circuit simulation program</title> + <para><emphasis>Spice</emphasis> is a general-purpose circuit simulation program for nonlinear DC, nonlinear + transient, and linear AC analyses. Circuits may contain resistors, capacitors, inductors, + mutual inductors, independent voltage and current sources, four types of dependent sources, + lossless and lossy transmission lines (two separate implementations), switches, uniform + distributed RC lines, and the five most common semiconductor devices: diodes, BJTs, JFETs, + MESFETs, and MOSFETs.</para> + <para><emphasis>Spice</emphasis> has built-in models for the semiconductor devices, and the user need specify + only the pertinent model parameter values. The model for the BJT is based on the + integral-charge model of Gummel and Poon; however, if the Gummel-Poon parameters are not + specified, the model reduces to the simpler Ebers-Moll model. In either case, charge-storage + effects, ohmic resistances, and a current-dependent output conductance may be included. The + diode model can be used for either junction diodes or Schottky barrier diodes. The JFET model + is based on the FET model of Shichman and Hodges. Six MOSFET models are implemented: MOS1 + is described by a square-law I-V characteristic, MOS2 [1] is an analytical model, while MOS3 + [1] is a semi-empirical model; MOS6 [2] is a simple analytic model accurate in the short-channel + region; MOS4 [3, 4] and MOS5 [5] are the BSIM (Berkeley Short-channel IGFET Model) and BSIM2. + MOS2, MOS3, and MOS4 include second-order effects such as channel-length modulation, + subthreshold conduction, scattering-limited velocity saturation, small-size effects, and + charge-controlled capacitances.</para> + <sect2 id="analyses-types"> + <title>Types of analyses</title> + + <sect3 id="dc-analyses"> + <title>DC analyses</title> + <para>The DC analysis portion of <emphasis>Spice</emphasis> (.DC) determines the DC operating point of the circuit + with inductors shorted and capacitors opened. The DC analysis options are specified on the .DC, + .TF, and .OP control lines. A DC analysis is automatically performed prior to a transient analysis + to determine the transient initial conditions, and prior to an AC small-signal analysis to determine + the linearized, small-signal models for nonlinear devices. If requested, the DC small-signal value + of a transfer function (ratio of output variable to input source), input resistance, and output + resistance is also computed as a part of the dc solution. The DC analysis can also be used to + generate dc transfer curves: a specified independent voltage or current source is stepped over a + user-specified range and the DC output variables are stored for each sequential source value. + </para> + </sect3> + + <sect3 id="ac-analyses"> + <title>AC Small-Signal Analysis</title> + <para>The AC small-signal portion of <emphasis>Spice</emphasis> (.AC) computes the AC output variables as a function of + frequency. The program first computes the DC operating point of the circuit and determines linearized, + small-signal models for all of the nonlinear devices in the circuit. The resultant linear circuit is + then analyzed over a user-specified range of frequencies. The desired output of an AC small-signal + analysis is usually a transfer function (voltage gain, trans-impedance, etc). If the circuit has only + one AC input, it is convenient to set that input to unity and zero phase, so that output variables + have the same value as the transfer function of the output variable with respect to the input.</para> + </sect3> + + <sect3 id="transient-analysis"> + <title>Transient analysis</title> + <para>The transient analysis portion of <emphasis>Spice</emphasis> (.TRAN) computes the transient output variables as a + function of time over a user-specified time interval. The initial conditions are automatically + determined by a DC analysis. All sources which are not time dependent (for example, power supplies) + are set to their DC value. The transient time interval is specified on a .TRAN control line. </para> + </sect3> + + <sect3 id="pole-zero-analysis"> + <title>Pole-Zero Analysis</title> + <para>The pole-zero analysis portion of <emphasis>Spice</emphasis> (.PZ) computes the poles and/or zeros in the small-signal + AC transfer function. The program first computes the DC operating point and then determines the linearized, + small-signal models for all the nonlinear devices in the circuit. This circuit is then used to find the + poles and zeros of the transfer function. + </para> + <para>Two types of transfer functions are allowed: one of the form (output voltage)/(input voltage) and + the other of the form (output voltage)/(input current). These two types of transfer functions cover all + the cases and one can find the poles/zeros of functions like input/output impedance and voltage gain. + The input and output ports are specified as two pairs of nodes. + </para> + <para>The pole-zero analysis works with resistors, capacitors, inductors, linear-controlled sources, + independent sources, BJTs, MOSFETs, JFETs and diodes. Transmission lines are not supported. + </para> + <para>The method used in the analysis is a sub-optimal numerical search. For large circuits it may + take a considerable time or fail to find all poles and zeros. For some circuits, the method becomes + "lost" and finds an excessive number of poles or zeros. + </para> + </sect3> + + <sect3 id="small-signal-distorsion-signal"> + <title>Small-Signal Distortion Analysis</title> + <para>The distortion analysis portion of <emphasis>Spice</emphasis> (.DISTO) computes steady-state harmonic and + intermodulation products for small input signal magnitudes. If signals of a single frequency are + specified as the input to the circuit, the complex values of the second and third harmonics are + determined at every point in the circuit. If there are signals of two frequencies input to the circuit, + the analysis finds out the complex values of the circuit variables at the sum and difference of the input + frequencies, and at the difference of the smaller frequency from the second harmonic of the larger + frequency. </para> + <para>Distortion analysis is supported for the following nonlinear devices: diodes (DIO), BJT, JFET, + MOSFETs (levels 1, 2, 3, 4/BSIM1, 5/BSIM2, and 6) and MESFETS. All linear devices are automatically + supported by distortion analysis. If there are switches present in the circuit, the analysis continues + to be accurate provided the switches do not change state under the small excitations used for distortion + calculations. </para> + </sect3> + + <sect3 id="sensistivity-analysis"> + <title>Sensitivity Analysis</title> + <para><emphasis>Spice</emphasis> will calculate (.SENS) either the DC operating-point sensitivity or the AC small-signal + sensitivity of an output variable with respect to all circuit variables, including model parameters. + <emphasis>Spice</emphasis> calculates the difference in an output variable (either a node voltage or a branch current) + by perturbing each parameter of each device independently. Since the method is a numerical approximation, + the results may demonstrate second order affects in highly sensitive parameters, or may fail to show very + low but non-zero sensitivity. Further, since each variable is perturb by a small fraction of its value, + zero-valued parameters are not analyized (this has the benefit of reducing what is usually a very large + amount of data). </para> + </sect3> + + <sect3 id="noise-analysis"> + <title>Noise Analysis</title> + <para>The noise analysis portion of <emphasis>Spice</emphasis> (.NOISE) does analysis device-generated noise for the given + circuit. When provided with an input source and an output port, the analysis calculates the noise + contributions of each device (and each noise generator within the device) to the output port voltage. + It also calculates the input noise to the circuit, equivalent to the output noise referred to the specified + input source. This is done for every frequency point in a specified range - the calculated value of the noise + corresponds to the spectral density of the circuit variable viewed as a stationary gaussian stochastic + process. </para> + <para>After calculating the spectral densities, noise analysis integrates these values over the specified + frequency range to arrive at the total noise voltage/current (over this frequency range). This calculated + value corresponds to the variance of the circuit variable viewed as a stationary gaussian process. + </para> + </sect3> + </sect2> + + <sect2 id="temperatures-analysis"> + <title>Analyses at different temperatures</title> + <para>All input data for <emphasis>Spice</emphasis> is assumed to have been measured at a nominal temperature of 27°C, which + can be changed by use of the TNOM parameter on the .OPTIONS control line. This value can further be + overridden for any device which models temperature effects by specifying the TNOM parameter on the model + itself. The circuit simulation is performed at a temperature of 27°C, unless overridden by a TEMP parameter + on the .OPTIONS control line. Individual instances may further override the circuit temperature through + the specification of a TEMP parameter on the instance. + </para> + <para>Temperature appears explicitly in the exponential terms of the BJT and diode model paras. In + addition, saturation currents have a built-in temperature dependence. The temperature dependence of the + saturation current in the BJT models is determined by: + </para> + <center> + <para>I<subscript>S</subscript>(T<subscript>1</subscript>) = I<subscript>S</subscript>(T<subscript>0</subscript>)*(T<subscript>1</subscript><superscript>XTI</superscript>/T<subscript>0</subscript>) + *exp(q*E<subscript>G</subscript>*(T<subscript>1</subscript>*T<subscript>0</subscript>)/(k*T<subscript>1</subscript>-T<subscript>0</subscript>)) </para> + </center> + <para>where k is Boltzmann's constant, q is the electronic charge, E<subscript>g</subscript> is the energy gap which is a model + parameter, and XTI is the saturation current temperature exponent (also a model parameter, and usually + equal to 3). + </para> + <para>The temperature dependence of forward and reverse beta is according to the formula: + </para> + <para>B(T<subscript>1</subscript>) = B(T<subscript>0</subscript>)* T<subscript>1</subscript><superscript>XTB</superscript>/T<subscript>0</subscript></para> + <pre> + XTI + |T | | E q(T T )| + 1 g 1 0 + I (T ) = I (T ) |--| exp|-----------| + S 1 S 0 + |T | |k (T - T )| + 0 1 0 + </pre> + <para>COUCOUCOUCOUCOIU</para> + + <mml:mrow> + <mml:mi>x</mml:mi> + <mml:mo>=</mml:mo> + <mml:mfrac> + <mml:mrow> + <mml:mrow><mml:mo>-</mml:mo><mml:mi>b</mml:mi></mml:mrow> + <mml:mo>±</mml:mo> + <mml:msqrt> + <mml:mrow> + <mml:msup><mml:mi>b</mml:mi><mml:mn>2</mml:mn></mml:msup> + <mml:mo>-</mml:mo> + <mml:mrow><mml:mn>4</mml:mn><mml:mi>a</mml:mi><mml:mi>c</mml:mi></mml:mrow> + </mml:mrow> + </mml:msqrt> + </mml:mrow> + <mml:mrow><mml:mn>2</mml:mn><mml:mo>⁢</mml:mo><mml:mi>a</mml:mi></mml:mrow> + </mml:mfrac> +</mml:mrow> + + <para>COUCOUCOUCOUCOIU</para> + + <para>where T<subscript>1</subscript> and T<subscript>0</subscript> are in kelvin, and XTB is a user-supplied model parameter. Temperature effects + on beta are carried out by appropriate adjustment to the values of BF, ISE, BR , and ISC (<emphasis>Spice</emphasis> model + parameters BF, ISE, BR, and ISC, respectively). + </para> + <para>Temperature dependence of the saturation current in the junction diode model is determined by: </para> + <para>I<subscript>S</subscript>(T<subscript>1</subscript>) = I<subscript>S</subscript>(T<subscript>0</subscript>)*(T<subscript>1</subscript><superscript>XTI</superscript>/T<subscript>0</subscript>) + *exp(q*E<subscript>G</subscript>*(T<subscript>1</subscript>*T<subscript>0</subscript>)/(k*T<subscript>1</subscript>-T<subscript>0</subscript>)) </para> + + <pre> + XTB + |T | + 1 + B(T ) = B(T ) |--| + 1 0 + |T | + 0 + </pre> + + + <para>where N is the emission coefficient, which is a model parameter, and the other symbols have + the same meaning as above. Note that for Schottky barrier diodes, the value of the saturation current + temperature exponent, XTI, is usually 2. + </para> + <para>Temperature appears explicitly in the value of junction potential, U (in <emphasis>Spice</emphasis> PHI), for all the + device models. The temperature dependence is determined by: + </para> + + <pre> + XTI + --- + N + |T | | E q(T T ) | + 1 g 1 0 + I (T ) = I (T ) |--| exp|-------------| + S 1 S 0 + |T | |N k (T - T )| + 0 1 0 + </pre> + <para>where k is Boltzmann's constant, q is the electronic charge, Na is the acceptor impurity density, + Nd is the donor impurity density, Ni is the intrinsic carrier concentration, and Eg is the energy gap. + </para> + <para>Temperature appears explicitly in the value of surface mobility, M0 (or UO), for the MOSFET model. + The temperature dependence is determined by: + </para> + <para>R(T) = R(T<subscript>0</subscript>) [1 + TC<subscript>1</subscript> (T - T<subscript>0</subscript> ) + TC<subscript>2</subscript> (T - T<subscript>0</subscript>)<superscript>2</superscript>] + </para> + <pre> + + | N N | + a d + kT |------ | + U(T) = -- log 2 + q e |N (T) | + i + </pre> + + + <para>The effects of temperature on resistors is modeled by the formula: + </para> + <para>I<subscript>S</subscript>(T<subscript>1</subscript>) = I<subscript>S</subscript>(T<subscript>0</subscript>)*(T<subscript>1</subscript><superscript>XTI</superscript>/T<subscript>0</subscript>) + *exp(q*E<subscript>G</subscript>*(T<subscript>1</subscript>*T<subscript>0</subscript>)/(k*T<subscript>1</subscript>-T<subscript>0</subscript>)) </para> + <pre> + M (T ) + 0 0 + M (T) = ------- + 0 1.5 + | T| + |--| + |T | + 0 + </pre> + + + + <para>where T is the circuit temperature, T<subscript>0</subscript> is the nominal temperature, and TC<subscript>1</subscript> and TC<subscript>2</subscript> are the first- + and second-order temperature coefficients. + </para> + </sect2> + + <sect2 id="convergence"> + <title>Convergence</title> + <para>Both dc and transient solutions are obtained by an iterative process which is terminated when both + of the following conditions hold: + </para> + <orderedlist> + <listitem> + <para>The nonlinear branch currents converge to within a tolerance of 0.1% or 1 picoamp (1.0<superscript>-12</superscript>A), whichever + is larger.</para></listitem> + <listitem><para>The node voltages converge to within a tolerance of 0.1% or 1 microvolt (1.0<superscript>-6</superscript>V), whichever is larger. + </para> + </listitem></orderedlist> + <para>Although the algorithm used in <emphasis>Spice</emphasis> has been found to be very reliable, in some cases it fails to + converge to a solution. When this failure occurs, the program terminates the job. + </para> + <para>Failure to converge in dc analysis is usually due to an error in specifying circuit connections, + element values, or model parameter values. Regenerative switching circuits or circuits with positive feedback + probably will not converge in the dc analysis unless the OFF option is used for some of the devices in the + feedback path, or the .NODESET control line is used to force the circuit to converge to the desired state. + </para> + </sect2> + + + </sect1> + + <sect1 id="getting-started"> + <title>Getting Started with Oregano</title> + + <para>When you first start &app;, you will be presented to an + empty sheet, where you can place circuit components and connect + them with wires. To place a component, also known as 'part', + first select one in the part browser on the right hand side of + the application window. Then press the 'Place' button, or double-click + the selected part. You can also drag the part preview and drop it + on the sheet.</para> + + <figure id="general-view"> + <title>&app; oregano: main window</title> + <screenshot><graphic fileref="figures/oregano-main-window.png" format="PNG"></graphic> + </screenshot> + </figure> + + <para>When you have some parts placed on the sheet, you can start + connecting them with wires. Select the wire tool on the toolbar, + and click on the sheet where you want the wire to start. Then + click where you want to fixate the wire.</para> + + <para>Make sure you connect at least one ground node to the circuit, + as this is neccessary to perform a simulation.</para> + + </sect1> + + <sect1 id="editing"> + <title>Editing the Circuit</title> + + <para>There are a few accelerator keys that can help editing the + circuit:</para> + + <variablelist> + <varlistentry><term>Ctrl-A</term><listitem><para>Select all objects on the sheet</para> + </listitem></varlistentry> + + <varlistentry><term>Ctrl-Shift-A</term><listitem><para>Deselect all objects</para> + </listitem></varlistentry> + + <varlistentry><term>r</term><listitem><para>Rotate the selected objects 90 degrees clockwise</para> + </listitem></varlistentry> + + <varlistentry><term><Del></term><listitem><para>Delete the selected objects</para> + </listitem></varlistentry> + + <varlistentry><term>l</term><listitem><para>Place the currently selected part</para> + </listitem></varlistentry> + + </variablelist> + + <para>Parts and wires can be selected by clicking on them, and by holding the + Shift-key while clicking, you can select multiple parts and wires. You can + also select objects by 'rubber-banding': hold down the mouse button while dragging + the pointer over the objects that you wish to select.</para> + + </sect1> + + <sect1 id="simulation"> + <title>Simulation</title> + + <para>When you have a circuit and wish to run a simulation, either press the + simulate button on the toolbar or select + <guimenu>Tools</guimenu>-><guimenuitem>Simulation</guimenuitem>. + The simulation then starts and you can follow the progress on the dialog box + that pops up.</para> + + <para>If you want to change the simulation parameters, select + <guimenu>Settings</guimenu>-><guimenuitem>Simulation Settings</guimenuitem>. + </para> + + </sect1> +</article> diff --git a/help/Makefile.am b/help/Makefile.am new file mode 100644 index 0000000..4d6054c --- /dev/null +++ b/help/Makefile.am @@ -0,0 +1 @@ +SUBDIRS = C es fr diff --git a/help/es/Makefile.am b/help/es/Makefile.am new file mode 100644 index 0000000..0c117c0 --- /dev/null +++ b/help/es/Makefile.am @@ -0,0 +1,7 @@ +#figdir = figures +docname = oregano +lang = es +omffile = oregano-es.omf +entities = legal.xml oregano.xml +include $(top_srcdir)/xmldocs.make +dist-hook: app-dist-hook diff --git a/help/es/legal.xml b/help/es/legal.xml new file mode 100644 index 0000000..70d0183 --- /dev/null +++ b/help/es/legal.xml @@ -0,0 +1,74 @@ +<legalnotice id="legalnotice"> + <para> + Permission is granted to copy, distribute and/or modify this + document under the terms of the GNU Free Documentation + License (GFDL), Version 1.1 or any later version published + by the Free Software Foundation with no Invariant Sections, + no Front-Cover Texts, and no Back-Cover Texts. You can find + a copy of the GFDL at this <ulink type="help" url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS + distributed with this manual. + </para> + <para> This manual is part of a collection of GNOME manuals + distributed under the GFDL. If you want to distribute this + manual separately from the collection, you can do so by + adding a copy of the license to the manual, as described in + section 6 of the license. + </para> + + <para> + Many of the names used by companies to distinguish their + products and services are claimed as trademarks. Where those + names appear in any GNOME documentation, and the members of + the GNOME Documentation Project are made aware of those + trademarks, then the names are in capital letters or initial + capital letters. + </para> + + <para> + DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED + UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE + WITH THE FURTHER UNDERSTANDING THAT: + + <orderedlist> + <listitem> + <para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS, + WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR + IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES + THAT THE DOCUMENT OR MODIFIED VERSION OF THE + DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR + A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE + RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE + OF THE DOCUMENT OR MODIFIED VERSION OF THE + DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR + MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT, + YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY + CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY + SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER + OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS + LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED + VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER + EXCEPT UNDER THIS DISCLAIMER; AND + </para> + </listitem> + <listitem> + <para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL + THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE), + CONTRACT, OR OTHERWISE, SHALL THE AUTHOR, + INITIAL WRITER, ANY CONTRIBUTOR, OR ANY + DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION + OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH + PARTIES, BE LIABLE TO ANY PERSON FOR ANY + DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR + CONSEQUENTIAL DAMAGES OF ANY CHARACTER + INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS + OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR + MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR + LOSSES ARISING OUT OF OR RELATING TO USE OF THE + DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT, + EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF + THE POSSIBILITY OF SUCH DAMAGES. + </para> + </listitem> + </orderedlist> + </para> + </legalnotice>
\ No newline at end of file diff --git a/help/es/oregano-es.omf b/help/es/oregano-es.omf new file mode 100644 index 0000000..b353465 --- /dev/null +++ b/help/es/oregano-es.omf @@ -0,0 +1,31 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE omf PUBLIC "-//OMF//DTD Scrollkeeper OMF Variant V1.0//EN" "http://scrollkeeper.sourceforge.net/dtds/scrollkeeper-omf-1.0/scrollkeeper-omf.dtd"> +<omf> + <resource> + <creator> + rmarkie@fi.uba.ar (Ricardo Markiewicz) + </creator> + <title> + Oregano User Guide + </title> + <date> + 2004-05-03 + </date> + <version identifier="0.0.3" date="2004-08-11" description="alpha version"/> + <subject category="GNOME|Core Desktop"/> + <description> + This document will describe the benefits of oregano 2, and show you + some examples. + </description> + <type> + manual + </type> + <format mime="text/xml" dtd="-//OASIS//DTD DocBook XML V4.1.2//EN"/> + <identifier url=""/> + <language code="C"/> + <relation seriesid="b57e7e48-be78-11d6-85a3-d094906a987c"/> + <rights type="GNU FDL" license.version="1.1" + license="http://www.gnu.org/licenses/fdl.html" holder="Havoc + Pennington, John Fleck"/> + </resource> +</omf> diff --git a/help/es/oregano.xml b/help/es/oregano.xml new file mode 100644 index 0000000..7b21aca --- /dev/null +++ b/help/es/oregano.xml @@ -0,0 +1,96 @@ +<?xml version="1.0"?> +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "/usr/share/xml/docbook/schema/dtd/4.1.2/docbookx.dtd" [ +<!ENTITY legal SYSTEM "legal.xml"> +<!ENTITY appversion "0.1"> +<!ENTITY manrevision "0.1"> +<!ENTITY date "03 Mayo 2004"> +<!ENTITY app "<application>Oregano</application>"> +]> +<article id="index" lang="es"> + <articleinfo> + <title><application>Oregano</application>Manual de Usuario</title> + <copyright> + <year>2003</year> + <year>2004</year> + <holder>LUGFi</holder> + </copyright> + <copyright> + <year>1999</year> + <year>2001</year> + <year>2002</year> + <holder>Richard Hult</holder> + </copyright> + <publisher> + <publishername> LUGFI </publishername> + </publisher> + + <authorgroup> + <author> + <firstname>Ricardo</firstname> <surname>Markiewicz</surname> + <affiliation> + <address> + <email>rmarkie@fi.uba.ar</email> + </address> + </affiliation> + </author> + </authorgroup> + <revhistory> + <revision> + <revnumber>Manual de Oregano</revnumber> + <date>2004</date> + <revdescription> + <para role="author">Ricardo Markiewicz</para> + </revdescription> + </revision> + </revhistory> + + <releaseinfo> + Oregano is a tool for schematic capture and simulation + of electronic circuits. It simplifes design of simple circuits + by letting the user draw the circuit and then simulate its + electrical characteristics. + + This document is mostly meant to be an introduction + for someone who already is familiar with circuit simulation + and wants to try out Oregano. + </releaseinfo> + <legalnotice> + <title>Feedback</title> + <para>To report a bug or make a suggestion regarding the + <application>Oregano</application> application or + this manual, follow the directions in the <ulink url="ghelp:oregano-feedback" type="help">Oregano Feedback Page</ulink>. + </para> + </legalnotice> + </articleinfo> + + <sect1 id="getting-started"> + <title>Introducción</title> + + + + + + + + <para><application>Oregano</application> es una aplicación de captura esquemática y simulación de circuitos electrónicos.</para></sect1> + + <sect1 id="editing"> + <title>Editando un Circuito</title> + + + + + + + + <para>Al iniciar la aplicación tendrá una hoja vacía donde podrá comenzar a agregar los componentes de su circuito. Los componentes se encuentran en la lista de la derecha, agrupados por categorías.</para></sect1> + + <sect1 id="simulation"> + <title>Simulación de Circuitos</title> + + + + + + <sect2><title>Parámetros de simulación</title><para>TODO</para></sect2></sect1> +<sect1><title>Configurar <application>Oregano</application></title><sect2><title>Opciones de Edición</title><para>TODO</para></sect2><sect2><title>Rutas de archivos</title><para>TODO : agregar que se supone que se configura aca</para><simplelist><member>Oregano Parser : Especifica el nómbre y ruta donde se encuentra el script <filename>oregano_parser.pl</filename> que es utilizado para la simulación. Este ejecutable es el encargado de realizar la simulación utilizando el motor (TODO:ver de poner un ref a donde se explique los motores de simulación) y entregar los datos en un formato que Oregano pueda entender.</member></simplelist></sect2><sect2><title>Formato de Archivos</title><simplelist><member>Comprimir los archivos guardados : Especifica si los archivos guardados deben ser comprimidos. Oregano utiliza el estandar XML para guardar los archivos. Al ser estos de texto, puede que uds quiera guardarlos comprimidos para que ocupen menos lugar. Tenga en cuenta que no todos los parsers XML soportan compresión y esta opción puede dificultar exportar el documento guardado para ser utilizado con otra aplicación.</member></simplelist></sect2><sect2><title>Motor de Simulación</title><para>Puede seleccionar entre dos motores de simulación : GNU Cap o ngSpice.</para></sect2></sect1></article> diff --git a/help/fr/Makefile.am b/help/fr/Makefile.am new file mode 100644 index 0000000..de2d88f --- /dev/null +++ b/help/fr/Makefile.am @@ -0,0 +1,7 @@ +#figdir = figures +docname = oregano +lang = fr +omffile = oregano-fr.omf +entities = legal.xml oregano.xml +include $(top_srcdir)/xmldocs.make +dist-hook: app-dist-hook diff --git a/help/fr/legal.xml b/help/fr/legal.xml new file mode 100644 index 0000000..b1ecadf --- /dev/null +++ b/help/fr/legal.xml @@ -0,0 +1,28 @@ + <legalnotice id="legalnotice"> + <para> + L'utilisateur est libre de copier, distribuer et/ou modifier le présent document dans les termes de la GFDL (GNU Free Documentation License), Version 1.1 ou toute autre version ultérieure publiée par la Free Software Foundation sans section invariante, sans texte de page de couverture et sans textes de plat verso. Vous trouverez un exemplaire de la GFDL au <ulink type="help" url="ghelp:fdl">lien</ulink> suivant ou dans le fichier COPYING-DOCS fourni avec le présent manuel. + </para> + <para> Le présent manuel fait partie d'une collection de manuels GNOME distribués dans les termes de la GFDL. Vous souhaitez, si vous le souhaitez, le distribuer indépendamment de la collection en incluant un exemplaire de la licence du manuel, comme le décrit la section 6 de la licence. + </para> + + <para> + La plupart des noms utilisés par les entreprises pour leurs produits et leurs services sont des marques déposées. Lorsque ces noms apparaissent dans la documentation GNOME et que les membres du projet de documentation GNOME sont informés de l'existence de ces marques déposées, ces noms apparaissent en majuscules, ou la première lettre en majuscule. + </para> + + <para> + LE PRÉSENT DOCUMENT ET SES VERSIONS DE MISE À JOUR SONT FOURNIS SOUS LES CONDITIONS DE L'ACCORD DE LICENCE DE DOCUMENTATION LIBRE GNU, SACHANT QUE : + + <orderedlist> + <listitem> + <para>LE PRÉSENT DOCUMENT EST FOURNI "TEL QUEL", SANS AUCUNE GARANTIE, EXPRESSE OU IMPLICITE, ET INCLUT SANS LIMITATION LES GARANTIES DE BONNE QUALITÉ MARCHANDE OU D'APTITUDE À UN EMPLOI PARTICULIER OU AUTORISÉ DU DOCUMENT OU DE SA VERSION DE MISE À JOUR. THE ENTIRE RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE OF THE DOCUMENT OR MODIFIED VERSION OF THE DOCUMENT IS WITH YOU. DANS LE CAS OU UN DOCUMENT OU SA VERSION DE MISE À JOUR S'AVÉRAIT DÉFECTUEUX DE QUELQUE MANIÈRE QUE CE SOIT, L'UTILISATEUR (ET NON LE REDACTEUR INITIAL, L'AUTEUR OU TOUT AUTRE PARTICIPANT) ENDOSSERA LES COÛTS NÉCESSAIRES À TOUTE INTERVENTION, RÉPARATION OU CORRECTION. CETTE LIMITATION DE RESPONSABILITÉ CONSTITUE UNE PARTIE ESSENTIELLE DE LA PRÉSENTE LICENCE. AUCUNE UTILISATION DU PRÉSENT DOCUMENT OU DE SA VERSION DE MISE À JOUR N'EST AUTORISÉE AUX TERMES DU PRÉSENT ACCORD, EXCEPTÉ SOUS CETTE LIMITATION DE RESPONSABILITÉ ; + </para> + </listitem> + <listitem> + <para>EN AUCUNE CIRCONSTANCE ET SOUS AUCUNE INTERPRÉTATION DE LA LOI, QU'IL S'AGISSE DE RESPONSABILITÉ CIVILE (Y COMPRIS LA NÉGLIGENCE), CONTRACTUELLE OU AUTRE, L'AUTEUR, LE RÉDACTEUR INITIAL, TOUT PARTICIPANT ET TOUT DISTRIBUTEUR DE CE DOCUMENTOU DE SA VERSION DE MISE À JOUR AINSI QUE TOUT FOURNISSEUR DE QUELQUE PARTIE QUE CE SOIT NE POURRONT ÊTRE TENUS RESPONSABLES À L'ÉGARD DE QUICONQUE POUR TOUT DOMMAGE DIRECT, INDIRECT, PARTICULIER OU ACCIDENTEL DE TOUT TYPE Y COMPRIS, SANS LIMITATION, LES DOMMAGES LIÉS À LA PERTE DE CLIENTÈLE, AUX ARRÊTS DE TRAVAIL, AUX DÉFAILLANCES ET AUX DYSFONCTIONNEMENTS INFORMATIQUES OU TOUT AUTRE DOMMAGE OU PERTE LIÉE À L'UTILISATION DU PRÉSENT DOCUMENT ET DE SES VERSIONS DE MISE À JOUR, ET CE MÊME SI CES PARTIES ONT ÉTÉ INFORMÉES DE LA POSSIBILITÉ DE TELS DOMMAGES. + </para> + </listitem> + </orderedlist> + </para> + </legalnotice> + + diff --git a/help/fr/oregano-fr.omf b/help/fr/oregano-fr.omf new file mode 100644 index 0000000..38cc2d6 --- /dev/null +++ b/help/fr/oregano-fr.omf @@ -0,0 +1,30 @@ +<?xml version="1.0" standalone="no"?> +<!DOCTYPE omf PUBLIC "-//OMF//DTD Scrollkeeper OMF Variant V1.0//EN" "http://scrollkeeper.sourceforge.net/dtds/scrollkeeper-omf-1.0/scrollkeeper-omf.dtd"> +<omf> + <resource> + <creator> + rmarkie@fi.uba.ar (Ricardo Markiewicz) + </creator> + <title> + Guide de l'Utilisateur d'Oregano + </title> + <date> + 2004-05-03 + </date> + <version identifier="0.0.3" date="2004-08-11" description="alpha version"/> + <subject category="GNOME|Core Desktop"/> + <description> + Ce document décrit les particularités d'oregano et les présente au travers d'exemples. + </description> + <type> + manual + </type> + <format mime="text/xml" dtd="-//OASIS//DTD DocBook XML V4.1.2//FR"/> + <identifier url=""/> + <language code="C"/> + <relation seriesid="b57e7e48-be78-11d6-85a3-d094906a987c"/> + <rights type="GNU FDL" license.version="1.1" + license="http://www.gnu.org/licenses/fdl.html" holder="Havoc + Pennington, John Fleck"/> + </resource> +</omf> diff --git a/help/fr/oregano.xml b/help/fr/oregano.xml new file mode 100644 index 0000000..5560841 --- /dev/null +++ b/help/fr/oregano.xml @@ -0,0 +1,137 @@ +<?xml version="1.0"?> +<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "/usr/share/xml/docbook/schema/dtd/4.1.2/docbookx.dtd" [ + <!ENTITY legal SYSTEM "legal.xml"> + <!ENTITY appversion "0.1"> + <!ENTITY manrevision "0.1"> + <!ENTITY date "03 Mayo 2004"> + <!ENTITY app "<application>Oregano</application>"> +]> +<article id="index" lang="fr"> + <articleinfo> + <title>Guide de l'Utilisateur d'<application>Oregano</application></title> + <copyright> + <year>2003</year> + <year>2004</year> + <holder>LUGFi</holder> + </copyright> + <copyright> + <year>1999</year> + <year>2001</year> + <year>2002</year> + <holder>Richard Hult</holder> + </copyright> + <publisher> + <publishername> LUGFI </publishername> + </publisher> + + <authorgroup> + <author> + <firstname>Ricardo</firstname> <surname>Markiewicz</surname> + <affiliation> + <address> + <email>rmarkie@fi.uba.ar</email> + </address> + </affiliation> + </author> + </authorgroup> + <revhistory> + <revision> + <revnumber>Oregano Manual V 0</revnumber> + <date>2004</date> + <revdescription> + <para role="author">Ricardo Markiewicz</para> + </revdescription> + </revision> + </revhistory> + + <releaseinfo> + Oregano est à la fois un logiciel de saisie de schéma + éléctrique et un outil de simulation. Dans son utilisation, + il simplifie la conception de cicuit éléctrique simple en + laissant l'utilisateur passer facilement de la saisie du + schéma à la simulation. + + Ce document ne prétend être qu'une introduction à la simulation + éléctrique pour celui qui est déjà familier à ce genre de pratique. + </releaseinfo> + <legalnotice> + <title>Retour d'expérience</title> + <para>Pour faire part d'un problème ou faire une suggestion au + sujet de <application>Oregano</application> ou de ce guide, nous + vous proposons de suivre les instructions proposées dans <ulink + url="ghelp:oregano-feedback" type="help">Oregano Feedback Page</ulink>. + </para> + </legalnotice> + </articleinfo> + + <sect1 id="getting-started"> + <title>Comment utiliser oregano pour la première fois</title> + + <para>Quand vous lancez Oregano, vous vous trouvez face à une feuille + de saisie vide, sur laquelle vous pouvez placer des composants et les + relier. Pour positionner un composant, sélectionner le dans le navigateur + de composants installé sur le côté droit de la fenêtre de l'application. + Appuyer, alors, sur le boutton « Placer » ou bien clicker deux fois sur + le composant choisi. Vous pouvez aussi partir du composant prévisualisé, + le faire glisser et le coller sur la feuille de saisie.</para> + + <para>Une fois que quelques composants sont positionnés sur la feuille + de saisie, vous pouvez commencez à les connecter. Sélectionner l'outil + de saisie des fils éléctriques sur la barre d'outils et clicker une fois + avec le boutton gauche de la souris pour déterminer le lieu de départ du + cablage. Pour arrêter le fil, cliquer à nouveau sur lieu où vous + souhaiter l'arrêter.</para> + + <para>Assurez-vous d'avoir connecter au moins une masse au circuit, + celle-ci étant nécessaire pour réaliser une simulation.</para> + + </sect1> + + <sect1 id="editing"> + <title>Saisie d'un circuit</title> + + <para>Il existe quelques raccourcis calvier permettant d'accélérer l'édition du + schéma :</para> + + <variablelist> + <varlistentry><term>Ctrl-A</term><listitem><para>Permet de sélectionner tous les objets + sur le schéma</para> + </listitem></varlistentry> + + <varlistentry><term>Ctrl-Shift-A</term><listitem><para>Permet de désélectionner tous les objets</para> + </listitem></varlistentry> + + <varlistentry><term>r</term><listitem><para>Permet de tourner l'objet sélectionner de 90 degrés dans le + sens des aiguilles d'une montre</para> + </listitem></varlistentry> + + <varlistentry><term><Del></term><listitem><para>Permet de détruire les objets sélectionnés</para> + </listitem></varlistentry> + + <varlistentry><term>l</term><listitem><para>Permet de mette en place le composant sélectionné</para> + </listitem></varlistentry> + + </variablelist> + + <para>Composants et fils sont sélectionnés en cliquant dessus, et en maintenant la + touche Shiftn vous pouvez effectuer une sélection multiple. Vous pouvez en outre + sélectionner plusieurs objets en les 'entourrant' : maintenez le boutton gauche appuyé + lorsque vous encadrez les objets que vous désirez sélectionner.</para> + + </sect1> + + <sect1 id="simulation"> + <title>Simulation</title> + + <para>Quand vous avez dessiné un circuit et souhaitez effectuer une simulation, + pressez soit le boutton sur la barre d'outils ou sélectionner <guimenu>Outils + </guimenu>-><guimenuitem>Simulation</guimenuitem>. + La simulation est alors lancée et vous suivez sa progression sur la fenêtre qui + apparait devant vous.</para> + + <para>Si vous souhaitez changer les paramètres de simulation, sélectionner + <guimenu>Paramètres</guimenu>-><guimenuitem>Paramètres de Simulation</guimenuitem>. + </para> + + </sect1> +</article> |
