r16853 by craig - More doc updates from Christoph
scribus-commit
scribus-commit at lists.scribus.net
Tue Sep 20 20:14:09 UTC 2011
Author: craig
Date: Tue Sep 20 20:14:09 2011
New Revision: 16853
URL: http://scribus.net/websvn/listing.php?repname=Scribus&sc=1&rev=16853
Log:
More doc updates from Christoph
Added:
trunk/Scribus/doc/en/install.html
trunk/Scribus/doc/en/install1.html
trunk/Scribus/doc/en/install2.html
trunk/Scribus/doc/en/install4.html
trunk/Scribus/doc/en/install5.html
trunk/Scribus/doc/en/lipsum.html
trunk/Scribus/doc/en/readme-os2.html
trunk/Scribus/doc/en/readme-win32.html
Modified:
trunk/Scribus/doc/en/about1.html
trunk/Scribus/doc/en/about2.html
trunk/Scribus/doc/en/bugreport.html
trunk/Scribus/doc/en/images/Scripter.png
trunk/Scribus/doc/en/images/docheader1.png
trunk/Scribus/doc/en/images/docheader2.png
trunk/Scribus/doc/en/images/rf2.png
trunk/Scribus/doc/en/index.html
trunk/Scribus/doc/en/renderframes.html
trunk/Scribus/doc/en/scripter1.html
Modified: trunk/Scribus/doc/en/about1.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=16853&path=/trunk/Scribus/doc/en/about1.html
==============================================================================
--- trunk/Scribus/doc/en/about1.html (original)
+++ trunk/Scribus/doc/en/about1.html Tue Sep 20 20:14:09 2011
@@ -4,96 +4,69 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>About the Scribus Team</title></head><body>
<h2>About the Scribus Team (in order of joining)</h2>
-<p>Franz Schmid - "Our Linus..." original author, main coder, software developer for a publishing company</p>
+<p><b>Franz Schmid (fschmid):</b> “Our Linus …”. The original author and main coder; software developer for a manufacturing company.</p>
-<p>Peter Linnell - aka mrdocs - started with testing the 0.3.6 version,
-took over the documentation writing for 0.5.0; tester, rpm builder,
-original web master for <a href="http://www.scribus.net/">www.scribus.net,</a> Pre-Press/IT consultant for publishing and e-commerce companies.</p>
+<p><b>Peter Linnell (mrdocs):</b> Started with testing the 0.3.6 version, took over the documentation writing for 0.5.0; tester, RPM builder,
+original web master for the Scribus website; pre-press/IT consultant for publishing and e-commerce companies.</p>
-<p>Craig Bradney - aka MrB - started with 1.1.1, testing, setup of
-docs.scribus.net and bugs.scribus.net, manages the IRC channel #scribus
-on freenode.net; IT Manager for global e-commerce company.
-</p><p>Petr Vaněk - started with 1.1.4, plug-in specialist, has
-written several Scribus plug-ins and the how-to for Scribus plug-in
-writing; software engineer.</p>
+<p><b>Craig Bradney (MrB):</b> Started with 1.1.1; coding, testing, setup of docs.scribus.net and bugs.scribus.net, manages the IRC channels on freenode.net; IT manager for a global e-commerce company.</p>
-<p>Riku Leino - aka Tsoots - started with 1.1.5, wrote the Document
-Template plug-in and the OO/HTML importers for 1.2.2; IT Manager for
-large non-profit in Finland.</p>
+<p><b>Petr Vaněk:</b> Started with 1.1.4; plug-in specialist, has written several Scribus plug-ins and the how-to for Scribus plug-in writing; software engineer.</p>
-<p>Craig Ringer - Worked on the scripter, build system and tested
-Windows and Mac OSX port beginnings. Contributed fixes for Python and
-other enhancements; IT/DTP administrator for daily newspaper. </p>
+<p><b>Riku Leino (Tsoots):</b> Started with 1.1.5; wrote the Document Template plug-in and the OpenOffice.org/HTML importers for 1.2.2; IT manager for a large non-profit organization in Finland.</p>
-<p>Andreas Vox - pronounced [fox] -- started with 1.3.0. Developed
-original Mac OS X native port, font API specialist, hates C++, likes
-good layout and has a stupid comment for anything: software developer.</p>
+<p><b>Andreas Vox – pronounced [fox] – (avox):</b> Started with 1.3.0; developed the original Mac OS X native port, font and PostScript specialist, hates C++, likes good layout and has a stupid comment for anything; software developer.</p>
-<p>Jean Ghali - handles the Windows native port and much of the color
-management coding. Pre-press and software engineer for printing company.</p>
+<p><b>Jean Ghali (jghali):</b> Handles the Windows native port and much of the color management coding, gifted bughunter; pre-press and software engineer.</p>
-<p>Oleksandr Moskalenko, Phd.- aka malex - maintainer of Scribus Debian
-packages, helps with internationalization, translation, and user
-support in #scribus on IRC, tool scripts and the new Drupal-based
-www.scribus.net site, GSoC representative; molecular biologist.</p>
+<p><b>Oleksandr Moskalenko (malex):</b> Maintainer of the Scribus Debian packages, helps with internationalization, translation, maintainer of the Scribus website, GSoC representative; molecular biologist.</p>
-<p>Pierre Marchand - fonts, canvas, text layout and shaping. Developer of FontMatrix, has own IT company. </p>
+<p><b>Pierre Marchand (pierremarc);</b> Fonts, canvas, text layout and shaping. Developer of FontMatrix, software developer for a publishing company.</p>
-<p>Christoph Schäfer - Leading bug reporter and tester for bleeding
-edge Scribus. Wiki editor and doc translator/proofreader, one of the
-main authors of the Offcial Manual.</p>
+<p><b>Christoph Schäfer (christoph_s):</b> Bug reporter and tester for bleeding edge Scribus, Wiki editor and doc translator/proofreader, one of the main authors of the Official Manual and the Scribus Online Help.</p>
-<p>Hermann Kraus - Wrote the Render frame system and GraphicsMagick and UniConvertor integration.</p>
-<p>Jain Basil Aliyas - Wrote the XTG and IDML import filters.<br>
-</p>
+<p><b>Hermann Kraus (Herm):</b> Wrote the Render Frame plug-in for 1.4 and GraphicsMagick and UniConvertor integration in 1.5.</p>
+
+<p><b>Jain Basil Aliyas (jainbasil)</b>: Wrote the XTG and IDML import filters, and worked on the next generation of the Scribus Scripter.</p>
+
+<p><b>Paul Smedley:</b> Maintainer of the OS/2 port.</p>
-<h2>The Supporting Cast and Former Developers</h2>
-<h4>Active users/contributors who have added to the Scribus community (in no particular order):</h4>
+<h2>The Supporting Cast and Former Developers (in no particular order):</h2>
-<p>Paul F. Johnson - aka Nodoid - started with sending patches for 0.8, did code review and code optimizing. </p>
+<p><b>Paul F. Johnson (Nodoid):</b> Started with sending patches for 0.8, did code review and code optimizing. </p>
-<p>Steve Callcott - aka sjc - wrote the Python plugin font sampler,
-which showed the real power of the Python Scripter in Scribus; works on
-systems control and consumer electronics, custom software and support.</p>
+<p><b>Steve Callcott (sjc):</b> Wrote the Python plug-in “Font Sampler”, which showed the real power of the Python Scripter in Scribus; works on systems control and consumer electronics, custom software and support.</p>
-<p>Alessandro Rimoldi - added fixes for localization and code clean-ups.</p>
+<p><b>Alessandro Rimoldi:</b> Added fixes for the Scripter and code clean-ups, GSoC mentor.</p>
-<p>J.J. Sarton - added some key patches for improving image handling and other improvements. Added the GIMP support to Scribus.</p>
+<p><b>J.J. Sarton:</b> Added some key patches for improving image handling and other improvements. Added the launcher for external image editors to Scribus.</p>
-<p>Alistair Robinson - added some important fixes for font handling in
-early Scribus versions. Also wrote the clever hack for GIMP to create
-CMYK TIFFs.</p>
+<p><b>Alistair Robinson:</b> Added some important fixes for font handling in early Scribus versions. Also wrote the clever hack for GIMP to create CMYK TIFFs.</p>
-<p>Maciej Hanski - Polish translator and writer of the PDF Forms how-to. One of the primary contributors to the Scribus wiki.</p>
+<p><b>Maciej Hanski:</b> Polish translator and writer of the “PDF Forms” how-to. One of the primary contributors to the Scribus Wiki.</p>
-<p>Yves Ceccone - Original French translator, wrote many of the Python
-scripts included with Scribus, maintained a large number of Docs for
-Scribus in French.</p>
+<p><b>Yves Ceccone:</b> Original French translator, wrote many of the Python scripts included with Scribus, maintained a large number of docs for Scribus in French.</p>
-<p>Martin Costabel - maintains the Scribus port and support libraries for Fink, allowing Scribus to run under X11 on MacOSX.</p>
+<p><b>Craig Ringer:</b> Worked on the scripter, build system and tested early Windows and Mac OS X ports. Contributed fixes for Python and other enhancements; IT/DTP administrator for a newspaper. </p>
-<p>Niyam Bhushan - contributed a terrific tutorial on Scribus.</p>
+<p><b>Martin Costabel:</b> Maintains the Scribus port and support libraries for Fink, allowing Scribus to run under X11 on Mac OS X.</p>
-<p>Marti Maria - for answering tons of our questions on color management and providing littlecms.</p>
+<p><b>Niyam Bhushan:</b> Contributed a terrific tutorial on Scribus.</p>
-<p>Johannes Rüschel - Excellent bug finder, former German translator.</p>
+<p><b>Marti Maria:</b> Answered tons of our questions on color management and provided littleCMS to the the Open Source world.</p>
-<p>Alexandre Prokoudine - Russian Translator, has helped a bunch with
-internationalization issues, as well as designing UI improvements;
-professional technical writer.</p>
+<p><b>Johannes Rüschel:</b> Excellent bug finder, former German translator.</p>
-<p>"Lukasz [DeeJay1] Jernas" - PLD Linux package maintainer. </p>
+<p><b>Alexandre Prokoudine:</b> Russian Translator, has helped a bunch with internationalization issues, as well as designing UI improvements; professional technical writer.</p>
-<p>Howard White - Retired Pre-Press Engineer - Testing and testing and more testing. Always daring to test bleeding edge code. </p>
+<p><b>Lukasz Jernas (DeeJay1):</b> PLD Linux package maintainer. </p>
-<p>Cedric Gemy - Graphics Professor and author - UI testing and feedback, GSoC mentor.</p>
+<p><b>Howard White:</b> Testing and testing and more testing; retired pre-press engineer.</p>
-<p>Dr. Greg Pittman - One of the primary contributors to the scribus wiki and the documentation, one of the main authors of the Offcial Manual; author of several useful Scribus scripts.<br>
-</p>
-<p>Paul Smedley - Maintainer of the OS/2 port.<br>
-</p>
+<p><b>Cedric Gemy:</b> UI testing and feedback, GSoC mentor; graphics professor and author of books on Open Source graphics software. </p>
+<p><b>Gregory Pittman:</b> One of the primary contributors to the Scribus wiki and the documentation, one of the main authors of the Official Manual and the Scribus Online Help; author of several useful Scribus scripts; neurologist.</p>
-Volker Ribbert - started with the German translation of the German docs.<br>
+<p><b>Volker Ribbert:</b> Started with the German translation of the docs.</p>
</body></html>
Modified: trunk/Scribus/doc/en/about2.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=16853&path=/trunk/Scribus/doc/en/about2.html
==============================================================================
--- trunk/Scribus/doc/en/about2.html (original)
+++ trunk/Scribus/doc/en/about2.html Tue Sep 20 20:14:09 2011
@@ -9,8 +9,8 @@
<h3>Why Page Layout is Different from Word Processing</h3>
<p>What can you do with Scribus – and what is a “page layout” program? </p>
-<p>First, you should be aware that Scribus, like all advanced DTP programs, is very different from a word processor. Word processors are designed to quickly set up a page, most likely US Letter or A4 size, then immediately begin entering text. Scribus, on the other hand, is an application designed to do page layout, such applications are more commonly known as Desktop Publishing (DTP) programs.</p>
-<p>These programs give users great flexibility in placing objects like photos, logos, text frames and shapes in an exact position and orientation with great precision. This page will cover some overall concepts of good, efficient page layout and design, but especially if you’re a first-time user, you are strongly encouraged to go through the <a href="qsg.html">Quick Start Guide</a> to get a sense of what Scribus can do and how to avoid mistakes.</p>
+<p>First, you should be aware that Scribus, like all advanced DTP programs, is very different from a word processor. Word processors are designed to quickly set up a page, most likely US Letter or A4 size, then immediately begin entering text. Scribus, on the other hand, is an application designed to do page layout, and such applications are more commonly known as Desktop Publishing (DTP) programs.</p>
+<p>These programs give users great flexibility in placing objects like photos, logos, text frames and shapes in an exact position and orientation with great precision. This page will cover some basic concepts of page layout and design, but especially if you’re a first-time user, you are strongly encouraged to go through the <a href="qsg.html">Quick Start Guide</a> to get a sense of what Scribus can do and how to avoid mistakes.</p>
<h3>The Final Assembly Line</h3>
<p>First-time users of page layout applications like Scribus can find starting out quite frustrating, since they expect to open a new document and immediately start typing, but a Scribus document is really just a space to work in, and there is no expectation that there will be any text at all.</p>
@@ -26,13 +26,13 @@
<p>Since there are many inspiring designs for almost every purpose available, it’s quite easy to find examples to stimulate your imagination. However, learning from existing examples is something different than copying a layout – it’s actually hard work, because you need to analyze a layout, for example by using a ruler to determine page margins, dimensions etc. This isn’t to say that all that you see that is eye-grabbing is good design for all circumstances. Start with a sense of what you want to do, perhaps educate someone or show off some visual display or product. Your intended purpose can then help you look for good examples of design that do this well.</p>
<p>Learning from the masters in the art will probably help you further with becoming creative yourself than anything else. Later you may find that reading books on page layout, typography or color theory help advance your knowledge, and most of them are full of inspiring examples.</p>
<p>Once you think you have created a great layout on your drawing block, the analyzing doesn’t stop, quite the contrary! Part of the planning stage is to determine which parts of your layout are static and should become part of a <a href="pagetemplate1.html">Master Page</a>. You also need to find out which elements will be repeatedly used in different places of your layout, as you can store all those elements in a single directory that can be used as a Scrapbook folder etc.</p>
-<p>Layout considerations aside, there is another important aspect to your project planning, namely the other side of the assembly process, commercial printing. It is <b>very</b> important to know beforehand what kind of files (e.g. PDF versions) a printer can handle, and if you plan to use <a href="color1.html">spot colors</a>, you should know in advance which colors the printer can reliably reproduce. All this information will influence the next stages of production on your side. Even if you will be printing on your own local printer, you need to be aware of the capabilities and limitations of your printer.</p>
+<p>Layout considerations aside, there is another important aspect to your project planning, namely the other side of the assembly process, commercial printing. It is <b>very</b> important to know beforehand what kind of files (e.g. PDF versions) a printer can handle, and if you plan to use <a href="color1.html">spot colors</a>, you should know in advance which colors the printer can reliably reproduce. All this information will influence the next stages of production on your side. Even if you will be printing on your own local printer, you need to be aware of the capabilities and limitations of the device.</p>
<h4>Preparing Your Suppliers</h4>
<p>Making all the materials yourself, such as text, images, and graphics, is certainly possible, but many who do page layout are coordinating and assembling these ingredients created or edited by others. Just like a manufacturer of machines is coordinating with its suppliers to avoid frictions and hiccups during the final assembly, you can avoid problems by providing guidelines to those who will produce the “components” or “ingredients” of your layout (and if you do everything yourself, you can make some mental notes to avoid hassles down the road). With experience, you will quickly see that altering the content can result in a need to extensively redesign the layout.</p>
<p>For writers it should be clear which file formats are acceptable. Ideally, only a single file format should be used, and if that’s impossible, perhaps due to different software tools available, plain text files can be used as the lowest common denominator. Writers should also be advised to use consistent spelling, quotes, dashes, etc.</p>
<p>As for graphics files, you should figure out which <a href="importhints.html">file formats</a> work best for you and then ask contributors of graphics not to use anything else. You should also provide clear guidelines for the use of <a href="color1.html">spot colors</a>, image resolutions and <a href="cms.html">color profiles</a>.</p>
<h4>Getting Ready to Work</h4>
-<p>From experience it can be said that the final layout should only be started when you have collected all the components you need, and that’s especially true for text. If an image needs color corrections it can be done with the layout in place, but changes to a text, like adding a line or even a paragraph, can result in a <b>lot</b> of extra work, as the placement of graphics or captions needs to be adjusted. Thus, make sure that no surprises will happen down the line.</p>
-<p>As you start your work, it’s always good practice to collect all project files in a single project directory, with subdirectories for text, vector graphics, image files and other file types you need for your project. Files that you want to re-use often should be moved into a single Scrapbook directory for use in Scribus. Once you’ve done all this, you are ready to go ...</p>
+<p>From experience it can be said that the final layout should only be started when you have collected all the components you need, and that’s especially true for text. If an image needs color corrections, these can be done with the layout in place, but changes to a text, like adding a line or even a paragraph, can result in a <b>lot</b> of extra work, as the placement of graphics or captions needs to be adjusted. Thus, make sure that no surprises will happen down the line.</p>
+<p>As you start your work, it’s always good practice to collect all project files in a single project directory, with subdirectories for text, vector graphics, image files and other file types you need for your project. Files that you want to re-use often should be moved into a single Scrapbook directory for use in Scribus. Once you’ve done all this, you are ready to go …</p>
</body>
</html>
Modified: trunk/Scribus/doc/en/bugreport.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=16853&path=/trunk/Scribus/doc/en/bugreport.html
==============================================================================
--- trunk/Scribus/doc/en/bugreport.html (original)
+++ trunk/Scribus/doc/en/bugreport.html Tue Sep 20 20:14:09 2011
@@ -1,80 +1,81 @@
<html>
-<head><TITLE>Filing a Bug Report</TITLE></head>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+ <title>Filing a Bug Report</title>
+</head>
+<body>
+<h2>Filing a Bug report</h2>
+<p>Successful software development is almost hopeless without testing, and that’s true for Scribus as well, of course. Testing means using the software, especially development versions. Bugs, when discovered, need to be reported to let the developers know that something’s wrong or at least seems to be wrong, so the problem can be fixed. Sometimes the fix may simply be a documentation update. Moreover, the developers need to know what kind of features users need. In such a case case, someone who is missing a feature or has a great idea, should let the Scribus Team know about it.</p>
-<body>
+<p>In all cases, the procedure is the same. There exists a software category called <i>bug tracking systems</i>, which allows developers to keep track of, discuss and review bug reports and RFEs (requests for enhancement). The Scribus Team has decided to use the <a href="http://www.mantisbt.org/">Mantis</a> bug tracking system. If you want to help with improving Scribus or absolutely need a feature, you are advised to learn how to use it.</p>
-<h1>Introduction</h1>
-<p>Software development is almost useless without testing, and that's true for Scribus as well, of course. Testing means using the software, especially development versions. Bugs, when discovered, need to be reported to let the developers know that something's wrong or at least seems to be wrong, so the problem can be fixed, if necessary. Sometimes the fix may simply be an update to the online documentation, the wiki or the next edition of the Official Manual. Moreover, the developers need to know what kind of features users need. In such a case case, someone who is missing a feature or has a great idea, should also let the team know about it.</p>
+<h2>Creating an Account</h2>
-<p>In both cases, the procedure is the same. There is a software called <i>bug tracking system</i>, in Scribus' case this is <a href="http://www.mantisbt.org/">Mantis</a>. A bug tracking system allows developers to keep track of, discuss and review bug reports and RFEs (requests for enhancement). If you want to help to improve Scribus or absolutely need a feature, you are advised to use it.</p>
-
-<h1>How to Create an Account</h1>
-
-<p>First, visit the <a href="http://bugs.scribus.net/signup_page.php">signup page</a>. You will see a page that looks like this:</p>
+<p>First, visit the <a href="http://bugs.scribus.net/signup_page.php">sign-up page</a>. You will see a page that looks like this:</p>
<br>
<table width="100%"><tr><td align="center"><img src="images/Mantis_signup.png"/></td></tr></table>
<br>
-<p>Enter a login name, your email address and the digits displayed. Then click <i>Signup</i> and wait until your account has been confirmed and you received a password. You can change your personal preferences any time in the tab "My account," provided you are logged in. Please take the time to check the different options. They may or may not be useful to you.</p>
+<p>Enter a login name, your e-mail address and the digits displayed. Then click “Signup” and wait until your account has been confirmed and you received a password via e-mail. You can change your personal preferences any time in the tab “My account,” provided you are logged in. Please take the time to check the different options. They may or may not be useful to you.</p>
-<h1>Before filing a bug</h1>
-<p>If something doesn't work as expected or you think you have the idea of the century, please don't start firing up bug reports galore. Chances are that someone has already had the same problem, perhaps even the same great idea. Five steps are recommended to ensure your report won't be closed as "duplicate" or "no change required".</p>
+<h2>Before Filing a Bug Report</h2>
+<p>If something doesn’t work as expected, or you think you have the idea of the century, please don’t start firing up bug reports galore. Chances are that someone has already had the same problem, perhaps even the same great idea. Five steps are recommended to ensure your report won’t be closed as “Duplicate” or “No change required”.</p>
-<ol><li>Read the <a href="http://docs.scribus.net/">Scribus documentation</a>, rummage the <a href="http://wiki.scribus.net/index.php">Scribus wiki</a> or even consider buying the <a href="http://www.scribus.net/?q=node/171">Official Scribus Manual</a>. There are lots of informations in different languages available, and perhaps someone has already turned his own experiences into a wiki article, or the documentation team may have documented a feature/issue thoroughly by then.</li>
-<li>Try to really use Scribus and learn about its concepts. Compared to other DTP programs, Scribus is not hard to learn, but it is still quite different from, say, a word processor.</li>
-<li>Tell one of the <a href="http://lists.scribus.info/mailman/listinfo/">mailing lists</a> about your problem or your idea. Things normally get sorted out quickly. Often enough, a supposed bug is just lack of experience.</li>
-<li>Ask questions on <a href="irc://irc.freenode.net/#scribus">IRC</a>. This is especially useful for "real time" support.</li>
-<li>If your questions still haven't been answered, you should browse the bug database. You can search for keywords. As you can see on the screenshot below, you can enter a keyword in the "Search" field. Then click <i>Apply</i>, and Mantis will search for all reports containing the text string. If you don't know the correct English word to search for, you can skim the multilingual <a href="/index.php/Glossary_of_technical_terms_used_in_Scribus_and_its_translations">Glossary</a> on the Wiki for a translation. If you use a non-English version of Scribus and want to look up the English names of menu items, just switch the Scribus interface to English: <i>File > Preferences > General > Language</i></li>
+<ol>
+<li>Read the <a href="http://docs.scribus.net/">Scribus Online Documentation</a>, rummage the <a href="http://wiki.scribus.net/index.php">Scribus Wiki</a>, or even consider buying the Official Scribus Manual. There are lots of informations in different languages available, and perhaps someone has already turned his own experiences into a Wiki article, or the documentation team may have documented a feature/issue thoroughly by then.</li>
+<li>Try to really use Scribus and learn about its concepts. The use of Scribus is not hard to learn, but it is still <a href="about2.html">quite different</a> from, say, a word processor.</li>
+<li>Post your problem or your idea on one of the <a href="mailing_lists.html">mailing lists</a>. Things normally get sorted out quickly. Often enough, a supposed bug is just lack of experience.</li>
+<li>Ask questions on <a href="irc.html">IRC</a>. This is especially useful for “real time” support.</li>
+<li>If your questions still haven’t been answered, you can browse the bug database. You can search for keywords. As you can see on the screenshot below, you can enter a keyword in the “Search” field. Then click “Apply,” and Mantis will search for all reports containing the text string. If you don’t know the correct English word to search for, you can skim the multilingual <a href="http://wiki.scribus.net/index.php/Glossary_of_technical_terms_used_in_Scribus_and_its_translations">Glossary</a> on the Wiki for a translation. If you use a non-English version of Scribus and want to look up the English names of menu items, just switch the Scribus interface language to English in the <a href="settings1.html#1">Preferences</a>.</li>
</ol>
<br>
<table width="100%"><tr><td align="center"><img src="images/Mantis_searching.png"/></td></tr></table>
<br>
-</p><p>You will notice that the reports are coloured differently. The meaning of the different colours is:</p>
+</p><p>You will notice that Mantis uses different colors to indicate the status of the reports. The meaning of the different colors is:</p>
<table class="width100" cellspacing="1"><tr><td class="small-caption" width="14%" bgcolor="#ffa0a0">new</td><td class="small-caption" width="14%" bgcolor="#ff50a8">feedback</td><td class="small-caption" width="14%" bgcolor="#ffd850">acknowledged</td><td class="small-caption" width="14%" bgcolor="#ffffb0">confirmed</td><td class="small-caption" width="14%" bgcolor="#c8c8ff">assigned</td><td class="small-caption" width="14%" bgcolor="#cceedd">resolved</td><td class="small-caption" width="14%" bgcolor="#e8e8e8">closed</td></tr></table>
<br>
-<ul><li><i>New</i>: The bug/RFE is reported, and no decision has been made as to how to handle it.</li>
-<li><i>Feedback</i>: Feedback is required from either the original reporter or someone who added a note to the report. This happens quite often in cases where an issue can't be reproduced.</li>
-<li><i>Acknowledged</i>: Once the team has decided a suggestion is worth keeping in mind for further development, the status is changed to "acknowledged." This is mostly the case with RFEs.</li>
-<li><i>Confirmed</i>: If a reported bug could be reproduced by others, the status will change to "confirmed." This is what usually happens to bug reports.</li>
-<li><i>Assigned</i>: A bug or RFE is assigned to a developer for fixing it or adding a feature.</li>
-<li><i>Resolved</i>: A bug or RFE is resolved. That doesn't necessarily mean a developer wrote any code. If things cannot or need not be fixed, the issue will be resolved as well.</li>
+<ul><li><i>New</i>: The bug/RFE has been reported, and no decision has been made as to how to handle it.</li>
+<li><i>Feedback</i>: Feedback is required from either the original reporter or someone who added a note to the report. This happens quite often in cases where an issue can’t be reproduced.</li>
+<li><i>Acknowledged</i>: Once the team has decided a suggestion is worth keeping in mind for further development, the status will be changed to “acknowledged.” This is mostly the case with RFEs.</li>
+<li><i>Confirmed</i>: If a reported bug could be reproduced by others, the status will be changed to “confirmed.” This is what usually happens to bug reports.</li>
+<li><i>Assigned</i>: A bug or RFE has been assigned to a developer for fixing it or adding a feature.</li>
+<li><i>Resolved</i>: A bug or RFE has been resolved. That doesn’t necessarily mean a developer wrote any code. If things cannot or need not be fixed, the issue will be resolved as well.</li>
<li><i>Closed</i>: The end of a life span of a report. If all works well, the issue will finally be closed, and the scary number of reports/requests is a bit smaller.</li>
</ul>
<br>
-<h1>How to file a bug report</h1>
-<br>To file a bug report, you have to click on the <i>Report Issue</i> link in your browser. You will be presented a page with lots of fields for entries:
+<h2>Filing a Bug Report</h2>
+<br>To file a bug report, you have to click on the “Report Issue” link in your browser. You will be presented a page with lots of fields for entries:
<br>
<table width="100%"><tr><td align="center"><img src="images/Mantis_new_report1.png"/></td></tr></table>
<br>
-<ul><li><i>Categories</i>: Choose a category you think your report fits best. If you can't find an appropriate category, choose "General."</li>
-<li><i>Reproducibility</i>: If you report a bug, can you reproduce it? How often does it happen? Choose the appropriate degree of frequency. RFEs have the reproducibility "Always," since the feature is always missing, until the issue is resolved.</li>
-<li><i>Select Profile</i>: In your personal preferences you can create user profiles for your reports. This is especially useful if you use more than one operating system or Distribution. You create a profile for each operating system, and if you file a report on an issue that occured on a particular system, you can simply choose the profile instead of inserting the data (Platform, OS, OS Version) by hand all the time.</li>
-<li><i>Platform</i>: Insert your CPU platform (e. g. x86, x86-64, PPC, SPARC)</li>
-<li><i>OS</i>: Your operating system (e.g. Linux, Windows, OS X)</li>
-<li><i>OS Version</i>: e. g. Debian 3.1, SuSE 10.1, Win2000, OS X 10.3</li>
-<li><i>Product Version</i>: Scribus has many incarnations: the stable branch, the developer branch with some more or less stable versions (1.4.xsvn, 1.5svn etc.). Make sure you choose the right one from the drop down menu.</li>
-<li><i>Product Build</i>: This is especially important if you are using <a href="http://docs.scribus.net/index.php?lang=en&page=install1">SVN versions</a> of Scribus. You find the relevant date in Scribus under <i>Help > About Scribus</i>. The date is very important, because the source code changes almost daily. An issue you report with an older version may very well already be resolved, in which case you will receive the recommendation to try the latest SVN version. <b>Please don't report issues for depracated versions of Scribus.</b></li>
+<ul><li><i>Categories</i>: Choose a category you think your report fits best. If you can’t find an appropriate category, choose “General.’</li>
+<li><i>Reproducibility</i>: If you report a bug, can you reproduce it? How often does it happen? Choose the appropriate degree of frequency. RFEs have the reproducibility “Always,” since the feature is always missing, until the issue is resolved.</li>
+<li><i>Select Profile</i>: In your personal preferences you can create user profiles for your reports. This is especially useful if you use more than one operating system or distribution. You can create a profile for each operating system, and if you file a report on an issue that occured on a particular system, you can simply choose the profile instead of inserting the data (Platform, OS, OS Version) repeatedly all the time.</li>
+<li><i>Platform</i>: Insert your CPU platform (e.g. x86, x86-64, PPC, SPARC) here.</li>
+<li><i>OS</i>: Your operating system (e.g. Linux, Windows, Mac OS X, OS/2, eCS).</li>
+<li><i>OS Version</i>: e.g. Debian 3.1, OpenSUSE 11.2, Windows XP, OS X 10.5, eCS 1.2</li>
+<li><i>Product Version</i>: Scribus exists in several incarnations, e.g. the stable branch or the developer branch with some more or less stable versions (1.4.xsvn, 1.5svn etc.). Make sure you choose the right one from the drop-down menu.</li>
+<li><i>Product Build</i>: This is especially important if you are using <a href="install1.html">SVN versions</a> of Scribus. Note that you won’t find the relevant date in Scribus under <i>Help > About Scribus</i>, as this string will be updated by the developers only occasionally. The date that matters is the one of your SVN checkout, because the source code changes almost daily. An issue you report with an older version may have already been resolved, in which case you will receive the recommendation to try the latest SVN version. <b>Please don’t report issues for depracated versions of Scribus.</b></li>
</ul>
-<p>If you have finished the preparations, you can finally start writing:</p>
+<p>Once you have finished the preparations, you can finally start writing your report:</p>
<br>
<table width="100%"><tr><td align="center"><img src="images/Mantis_new_report2.png"/></td></tr></table>
<br>
-<ul><li><i>Summary</i>: A short description of your report. This will become the "headline" in the bug tracker.</li>
-<li><i>Description</i>: Describe your issue as precisely as possible, but keep it concise. <b>No Novels here!</b> It may also be helpful to upload some screenshots (see below). If you file a feature request, please add a real world scenario. The team needs examples to understand what the idea is and how this new feature would help people to work better and more efficiently. In other words, try to describe not only <i>what</i> and <i>how</i>, but also <i>why</i>.</li>
-<li><i>Steps to reproduce</i>: If you are able to reproduce a bug, please write down the steps necessary for reproduction on other machines.</li>
+<ul><li><i>Summary</i>: A short description of your report. This will become the “headline” in the bug tracker.</li>
+<li><i>Description</i>: Describe your issue as precisely as possible, but keep it concise. <b>Please don’t write any novels here!</b> It may also be helpful to upload some screenshots (see below). If you file a feature request, please add a real world scenario. The team needs examples to understand what the idea is and how this new feature would help people to work better and more efficiently. In other words, try to describe not only <i>what</i> and <i>how</i>, but also <i>why</i>.</li>
+<li><i>Steps to reproduce</i>: If you are able to reproduce a bug, please write down the steps necessary for reproduction on other computers.</li>
<li><i>Additional information</i>: If you think other information, e.g. postings from the mailing list or messages from a debugger</a>, are useful in this context, you can add them here.</li>
</ul>
-<br>
-<p>You're almost done now, but you may want to upload a file, a screenshot for instance, or a Scribus sample file. Click <i>Search</i>or enter the path to the file on your hard drive or a URL.</p>
+<p>You’re almost done now, but you may want to upload a file, a screenshot for instance, or a Scribus sample file. Click “Search” or enter the path to the file on your hard drive or a URL.</p>
<br>
<table width="100%"><tr><td align="center"><img src="images/Mantis_new_report3.png"/></td></tr></table>
<br>
-<p>If you don't want a report to be seen by other reporters, but only the team, you can switch the status to "Private." This may be the case if you discover issues with a file that is protected by copyrights. Check "Private," and only a handful of people will see the file.</p><p>Once everything is to your satisfaction, click <i>Submit Report</i>, and you're done.</p>
+<p>If you don’t want a report to be seen by other reporters, but only the developers, you can switch the status to “Private.” This may be the case if you discover issues with a file that is protected by copyrights. Check “Private,” and only a handful of people will see the file.</p><p>Once everything is to your satisfaction, click “Submit Report,” and you’re done.</p>
-<h1>Personalised View</h1>
-<p>Provided you are logged in, you can choose a more clearly laid out view of the bugtracker. Click on the link <i>My view</i>, and Mantis will present a structured view of recently changed issues:
+<h2>Personalized View</h2>
+<p>Provided you are logged in, you can choose a more clearly laid out view of the bugtracker. Click on the link “My view,” and Mantis will present a structured view of recently changed issues:
<br>
<table width="100%"><tr><td align="center"><img src="images/Mantis_my_view.png"/></td></tr></table>
<br>
Modified: trunk/Scribus/doc/en/images/Scripter.png
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=16853&path=/trunk/Scribus/doc/en/images/Scripter.png
==============================================================================
Binary files - no diff available.
Modified: trunk/Scribus/doc/en/images/docheader1.png
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=16853&path=/trunk/Scribus/doc/en/images/docheader1.png
==============================================================================
Binary files - no diff available.
Modified: trunk/Scribus/doc/en/images/docheader2.png
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=16853&path=/trunk/Scribus/doc/en/images/docheader2.png
==============================================================================
Binary files - no diff available.
Modified: trunk/Scribus/doc/en/images/rf2.png
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=16853&path=/trunk/Scribus/doc/en/images/rf2.png
==============================================================================
Binary files - no diff available.
Modified: trunk/Scribus/doc/en/index.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=16853&path=/trunk/Scribus/doc/en/index.html
==============================================================================
--- trunk/Scribus/doc/en/index.html (original)
+++ trunk/Scribus/doc/en/index.html Tue Sep 20 20:14:09 2011
@@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<title>Scribus – Open Source Desktop Publishing</title>
</head>
-<table border="0" cellspacing="0" cellpadding="0" width="100%" bgcolor="#2780b9" >
+<table border="0" cellspacing="0" cellpadding="0" width="100%" bgcolor="#183867" >
<tr>
<td align="left"><img src="images/docheader1.png" width="222" height="87"></td>
<td align="right"><img src="images/docheader2.png" width="318" height="87"></td>
@@ -15,7 +15,7 @@
<!--marker for image gallery-->
-<p>Welcome to Scribus, a page layout program for Linux/UNIX, Mac OS X, OS/2 Warp 4, eComStation and Windows desktops.</p>
+<p>Welcome to Scribus, a page layout program for Linux/UNIX, Mac OS X, OS/2 Warp 4, eComStation and Windows.</p>
<p>Since its humble beginning in the spring of 2001, Scribus has rapidly evolved into one of the premier Open Source desktop applications. Encouraged by professionals and beginners alike, the Scribus Team, supported by a large and constantly growing number of enthusiastic contributors from all over the world, is dedicated to develop and improve “one of the most powerful and useful open-source projects out there” (TechRepublic).</p>
Modified: trunk/Scribus/doc/en/renderframes.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=16853&path=/trunk/Scribus/doc/en/renderframes.html
==============================================================================
--- trunk/Scribus/doc/en/renderframes.html (original)
+++ trunk/Scribus/doc/en/renderframes.html Tue Sep 20 20:14:09 2011
@@ -1,255 +1,137 @@
<body>
<head><TITLE>Render Frames</TITLE></head>
<body>
-<h1>Introduction</h1>
-<p>Since version 1.3.5 Scribus contains a powerful new feature called
-Render Frames. Originally planned as a means to insert formulas into
-Scribus documents, the inventor, Hermann Kraus, has enabled the
-creation of almost any kind of special typesetting, like formulas,
-musical notation or chess notation, from within Scribus. The trick here is that Scribus uses other programs in the background. It imports their output into a special frame type called <b>Render Frames</b>.</p>
-<p>While this feature is extremely versatile, you must not forget
-that the use of it requires knowledge of the markup codes
-required by a particular program. These commands are beyond the scope
-of the Scribus documentation.</p>
-<h1>Creating a Render Frame</h1>
-<p>To create a Render Frame, click on the Render Frame icon in the
-menu bar, use <i>Insert > Render Frame</i>, or press D on the
-keyboard:</p>
+<h2>Introduction</h2>
+<p>Since version 1.3.5 Scribus offers a powerful new feature called Render Frames. Originally planned as a means to insert formulas into
+Scribus documents, the inventor, Hermann Kraus, has enabled the creation of almost any kind of special typesetting, like formulas, musical notation or chess notation, from within Scribus. The trick here is that Scribus uses other programs in the background and imports their output into a special frame type called <b>Render Frames</b>.</p>
+<p>While this feature is extremely versatile, you must not forget that the use of it requires knowledge of the markup codes required by a particular program. These commands are beyond the scope of the Scribus documentation.</p>
+<h2>Creating a Render Frame</h2>
+<p>To create a Render Frame, click on the Render Frame icon in the menu bar, use <i>Insert > Render Frame</i>, or press D on the keyboard:</p>
<table width="100%"><tr><td align="center"><img src="images/rf2.png"/></td></tr></table>
<p>The cursor will then turn into a frame symbol with an L inside:</p>
<table width="100%"><tr><td align="center"><img src="images/DrawLatexFrame.png"/></td></tr></table>
<p><br><br>
</p>
-<p>The next step is to click-drag the frame and let up, just like you would do
-with a text frame. By default, Scribus will display a welcome
-message, which indicates that at least the configuration for LaTeX is
-correct. What you see below is the output from LaTeX, rendered in Scribus.
-The welcome message will be displayed in the language of the user
-interface as set in <i>File > Preferences</i>. If no translation
-of the message is available, you will see the English version:</p>
+<p>The next step is to click-drag the frame and let up, just like you would do with a text frame. By default, Scribus will display a welcome message, which indicates that at least the configuration for LaTeX is correct. What you see below is the output from LaTeX, rendered in Scribus. The welcome message will be displayed in the language of the user interface as set in the <a href="settings1.html#1">Preferences</a>. If no translation of the message is available, you will see the English version:</p>
<table width="100%"><tr><td align="center"><img src="images/rf3.png"/></td></tr></table>
-<p>The
-screenshot above has been made with the default resolution of 72 dpi,
-which, obviously, isn't enough for printing. You can easily change
-the resolution as you'll learn below.</p>
+<p>The screenshot above has been made with the default resolution of 72 dpi, which, obviously, isn’t enough for printing. You can easily change the resolution as you’ll learn below.</p>
<h1>Editing Render Frames</h1>
-<p>If
-you right-click on a Render Frame, the context menu shows an entry
-called "Edit Source:"</p>
+<p>If you right-click on a Render Frame, the context menu shows an entry called “Edit Source:”</p>
<table width="100%"><tr><td align="center"><img src="images/rf4.png"/></td></tr></table>
-<p>Selecting it brings up the "heart" of the Render Frame, the
-editor:</p>
+<p>Selecting it brings up the “heart” of the Render Frame, the editor:</p>
<table width="100%"><tr><td align="center"><img src="images/rf5.png"/></td></tr></table>
-<p>In Scribus 1.3.5, the editor is preconfigured to use LaTeX,
-Lilypond, gnuplot, dot/GraphViz and POV-Ray.</p>
-<p>To the left you see a field with the caption "Enter Code."
-Here you can insert the markup code for the output you want from the
-external program. For preconfigured renderers Scribus is shipped with some simple code snippets that will enable you to test if the respective programs are installed and configured properly. As you can see, the editor provides syntax
-highlighting.</p>
-<p>The "Update" button beneath the text field will update the
-content of the Render Frame, so that you can visually check the
-results of changes you made to the markup text without closing the editor. "Revert" will
-revert any change you made to the text. Please be aware that once you started editing the text, it's no longer possible to change the markup renderer, e.g., if you started editing LaTeX sourcecode, you cannot switch to Lilypond anymore.</p>
-<p>To the right you see a row of tabs. These are not available for
-all preconfigured markup languages, so sometimes the editor only shows the
-"Options" tab.
+<p>In Scribus 1.4, the editor is preconfigured to use LaTeX, Lilypond, gnuplot, dot/GraphViz and POV-Ray.</p>
+<p>To the left you see a field with the caption “Enter Code.” Here you can insert the markup code for the output you want from the external program. For preconfigured renderers Scribus is shipped with some simple code snippets that will enable you to test whether the respective programs are installed and configured properly. As you can see, the editor provides syntax highlighting.</p>
+<p>The “Update” button beneath the text field will update the content of the Render Frame, so that you can visually check the results of changes you made to the markup text without closing the editor. “Revert” will revert any change you made to the text. Please be aware that once you started editing the text, it’s no longer possible to change the markup renderer, e.g., if you started editing LaTeX source code, you cannot switch to Lilypond anymore.</p>
+<p>To the right you see a row of tabs. These are not available for all preconfigured markup languages, so sometimes the editor only shows the “Options” tab.
</p>
-<p>In the "Options" tab, the first entry is "Resolution." Its
-default setting is "Automatic," thus, 72 dpi as explained above.
-You can easily change the resolution of the output to something more
-suitable for printing.</p>
-<p>"Program" shows the list of supported programs. The editor
-will list all programs that are configured in <I>File >
-Preferences> External Tools</I>.</p>
-<p>If you check "Use Preamble," the editor will automatically use
-the preamble and the postamble as specified in the XML configuration
-files. See below for more details.</p>
-<p>"Program Messages" shows the messages that would otherwise be
-displayed in a command-line interpreter. They are "intercepted"
-by Scribus, just like the final output, and they are often useful to
-find out what went wrong if the rendering failed.</p>
-<p>If you click on "Run external editor," Scribus will start the
-editor as specified in <i>File > Preferences</i>,
-and "Kill Program" will stop the external program. This can be
-useful when the external program stumbles across an error you made in
-your markup that causes the external program to fail or even crash.</p>
-<h1>Preconfigured Programs</h1>
-<h2>LaTeX</h2>
+<p>In the “Options” tab, the first entry is “Resolution.” Its default setting is “Automatic,” thus, 72 dpi as explained above. You can easily change the resolution of the output to something more suitable for printing.</p>
+<p>“Program” shows the list of supported programs. The editor will list all programs that are configured in <I>File > Preferences> External Tools</I>.</p>
+<p>If you check “Use Preamble,” the editor will automatically use the preamble and the postamble as specified in the XML configuration files. See below for more details.</p>
+<p>“Program Messages” shows the messages that would otherwise be displayed in a command-line interpreter. They are “intercepted” by Scribus, just like the final output, and they are often useful to find out what went wrong if the rendering failed.</p>
+<p>If you click on “Run external editor,” Scribus will start the editor as specified in the Preferences, and “Kill Program” will stop the external program. This can be useful when the external program stumbles across an error you made in your markup that causes the external program to fail or even crash.</p>
+<h2>Preconfigured Programs</h2>
+<h3>LaTeX</h3>
<table width="100%"><tr><td align="center"><img src="images/rf6.png"/></td></tr></table>
-<p>The first LaTeX tab is called
-"Fonts/Headers." In the upper drop-down list you can set the font
-used for a Render Frame that uses LaTeX. By default, only four fonts
-are listed, but you can easily add more by editing the LaTeX XML
-configuration file as described in detail below: Just add another font under <code><list name="font"
-default=""></code> in the file. Please note that the font list
-for LaTeX (and many other markup programs) is completely different
-from the fonts available to you in Scribus and other programs, as
-LaTeX uses its own fonts and needs to be configured to use the Type 1, TrueType and OpenType fonts available to you in programs like
-Scribus or OpenOffice.org. For more information about LaTeX font configuration see the <a href="http://www.latex-project.org/guides/fntguide.pdf">LaTeX Font Selection Guide (PDF)</a>.</p>
-<p>The next drop-down list allows
-for changing the default font size. If you are used to LaTeX, you
-will already know that this is the setting for the base font. Other
-necessary font sizes, e.g. for superscript and subscript are
-determined by LaTeX. You will also note that the editor lists only a
-selection of base font sizes. Again, you can easily add other sizes
-under <code><list name="fontsize" default="11pt"></code>
-in the LaTeX XML configuration file. Since there are almost no limits
-as to the possibilities you have for the configuration of a LaTeX
-file, you will appreciate the option to select different XML
-configuration files in <i>File > Preferences > External
-Tools</i>.</p>
-<p>The text field "Additional
-Headers" allows for the insertion of additional headers to the
-preamble of the LaTeX markup, which will be stored within the Scribus sla
-file.</p>
-<p>Finally, you find different tabs
-with symbols and characters that can be created by LaTeX:</p>
+<p>The first LaTeX tab is called “Fonts/Headers.” In the upper drop-down list you can set the font used for a Render Frame that uses LaTeX. By default, only four fonts are listed, but you can easily add more by editing the LaTeX XML configuration file as described in detail below: Just add another font under <code><list name="font" default=""></code> in the file. Please note that the font list for LaTeX (and many other markup programs) is probably completely different from the fonts available to you in Scribus and other programs, as LaTeX uses its own fonts and needs to be configured to use the Type 1, TrueType and OpenType fonts available to you in programs like Scribus or LibreOffice. For more information about LaTeX font configuration see the <a href="http://www.latex-project.org/guides/fntguide.pdf">LaTeX Font Selection Guide (PDF)</a>.</p>
+<p>The next drop-down list allows for changing the default font size. If you are used to LaTeX, you will already know that this is the setting for the base font. Other necessary font sizes, e.g. for superscript and subscript are determined by LaTeX. You will also note that the editor lists only a
+selection of base font sizes. Again, you can easily add other sizes under <code><list name="fontsize" default="11pt"></code>
+in the LaTeX XML configuration file. Since there are almost no limits as to the possibilities you have for the configuration of a LaTeX file, you will appreciate the option to select different XML configuration files in <i>File > Preferences > External Tools</i>.</p>
+<p>The text field “Additional Headers” allows for the insertion of additional headers to the preamble of the LaTeX markup, which will be stored within the Scribus SLA file.</p>
+<p>Finally, you find different tabs with symbols and characters that can be created by LaTeX:</p>
<table width="100%"><tr><td align="center"><img src="images/rf7.png"/></td></tr></table>
-<p>To
-insert a single symbol into your markup code, you can either select
-the symbol and click "Insert Symbol" or double-click on the icon
-in the field.</p>
+<p>To insert a single symbol into your markup code, you can either select the symbol and click “Insert Symbol” or double-click on the icon in the field.</p>
<p>For more information see the <a href="http://www.latex-project.org/">official LaTeX website</a>.</p>
-<h2>Lilypond</h2>
+<h3>Lilypond</h3>
<table width="100%"><tr><td align="center"><img src="images/lilyp.png"/></td></tr></table>
-There are no additional options for Lilypond available.
+<p>There are no additional options for Lilypond available.</p>
<p>For more information see the <a href="http://lilypond.org/web/">official Lilypond website</a>.</p>
-<h2>gnuplot</h2>
+<h3>gnuplot</h3>
<table width="100%"><tr><td align="center"><img src="images/plot1.png"/></td></tr></table>
<br></br>
-The gnuplot options are very basic. Under <i>Ranges</i> you can enter the start and end digits for the x- and the y-axis. The default is an asterisk, which will result in gnuplot creating the digits automatically, according to the values set in the markup text.
+<p>The gnuplot options are very basic. Under “Ranges” you can enter the start and end digits for the X and the Y axis. The default is an asterisk, which will result in gnuplot creating the digits automatically, according to the values set in the markup text.</p>
<br></br>
<table width="100%"><tr><td align="center"><img src="images/plot2.png"/></td></tr></table>
<br></br>
-The tab called <i>Labels</i> serves as an assistant to determine some visual aspects of a graph:
+<p>The tab called “Labels” serves as an assistant to determine some visual aspects of a graph:</p>
<ul>
-<li><i>Title</i> will create a title for your graph, which will be placed at the top of the rendered image.</li>
-<li><i>X-Label</i> and <i>Y-Label</i> will create captions for the x- and y-axis.</li>
-<li><i>Grid</i> and <i>Grid layer</i> work similiar to the guides/page grid settings in Scribus, except that the grid in the graph will become part of the rendered image. You can choose between no grid at all, the major grid ("Major ticks only") and major plus minor grid ("Major and minor ticks"). Just like in Scribus you can also decide to have the grid rendered in the background or in the foreground.</li>
-<li><i>Zero axis</i> will create a dotted line to indicate either the x- or the y-axis, or both. Note that using any grid will make the setting of any zero axis unnecessary, as both use the same colour. If you want to use a different line style for grid and the axes, you have to do this in the markup text. Likewise, adding a z-axis requires the editing of the graph's source code.</li>
+<li>“Title” will create a title for your graph, which will be placed at the top of the rendered image.</li>
+<li>“X-Label” and “Y-Label” will create captions for the X and Y axis.</li>
+<li>“Grid” and “Grid Layer” work similiar to the guides/page grid settings in Scribus, except that the grid in the graph will become part of the rendered image. You can choose between no grid at all, the major grid (“Major ticks only”) and major plus minor grid (“Major and minor ticks”). Just like in Scribus you can also decide to have the grid rendered in the background or in the foreground.</li>
+<li>“Zero axis” will create a dotted line to indicate either the X or the Y axis, or both. Note that using any grid will make the setting of any zero axis unnecessary, as both use the same color. If you want to use a different line style for grid and the axes, you have to do this in the markup text. Likewise, adding a Z axis requires the editing of the graph’s source code.</li>
</ul>
<p>For more information see the <a href="http://www.gnuplot.info/">official gnuplot website</a>.</p>
-<h2>dot/Graphviz</h2>
+<h3>dot/Graphviz</h3>
-There are no additional options for dot/Graphviz available.
+<p>There are no additional options for dot/Graphviz available.</p>
<p>For more information see the <a href="http://www.graphviz.org/">official Graphviz website</a>.</p>
-<h2>POV-Ray</h2>
+<h3>POV-Ray</h3>
<table width="100%"><tr><td align="center"><img src="images/povray.png"/></td></tr></table>
<br></br>
-<p>The editor offers only one tab for the rendering of POV-Ray files, namley "Rendering Options:" </p>
+<p>The editor offers only one tab for the rendering of POV-Ray files, namley “Rendering Options:” </p>
<ul>
-<li><i>Quality</i> provides the same seven quality levels as the POV-Ray command-line interface, and the editor uses the same default level ("Compute media and radiosity"). Otherwise, the quality levels are listed in an ascending order, "Just show quick colors" providing the lowest quality.</li>
-<li><i>Antialiasing</i> is a technique to "smoothen" edges in a rendered image. It can dramatically improve the quality of an image, but using it may result in much longer rendering times. The options <i>Antialiasing Threshold</i> and <i>Antialiasing Depth</i> are explained in detail in the POV-Ray documentation, but the default values should suffice in most cases.</li></ul>
+<li>“Quality” provides the same seven quality levels as the POV-Ray command-line interface, and the editor uses the same default level (“Compute media and radiosity”). Otherwise, the quality levels are listed in an ascending order, “Just show quick colors” providing the lowest quality.</li>
+<li>“Antialiasing” is a technique to “smoothen” edges in a rendered image. It can dramatically improve the quality of an image, but using it may result in much longer rendering times. The options “Antialiasing Threshold” and “Antialiasing Depth” are explained in detail in the POV-Ray documentation, but the default values should suffice in most cases.</li></ul>
<p>For more information see the <a href="http://www.povray.org/">official POV-Ray website</a>.</p>
-<h1>Rendering</h1>
-<p>Once you have created the markup
-to your satisfaction, you can click the "OK" button.</p>
-<p>If you made a mistake, and the
-external program cannot render your markup, Scribus displays an error
-message:</p>
+<h2>Rendering</h2>
+<p>Once you have created the markup to your satisfaction, you can click the “OK” button.</p>
+<p>If you made a mistake, and the external program cannot render your markup, Scribus will display an error message:</p>
<table width="100%"><tr><td align="center"><img src="images/rf8.png"/></td></tr></table>
<p><br><br>
</p>
-<p>A blue X in the Render Frame along with an error message will
-then indicate that no content could be rendered:</p>
+<p>A blue “X” in the Render Frame along with an error message will then indicate that no content could be rendered:</p>
<table width="100%"><tr><td align="center"><img src="images/rf-error2.png"/></td></tr></table>
<h2>Additional Notes</h2>
-<p>If you look at the context menu
-for Render Frames, you will get the impression that they are image
-frames. In a sense, that's correct, as you can change the preview
-settings for Render Frames or update the content. There is, however,
-a major difference: As said above, the markup text ist stored within
-a Scribus file, and the rendered content is always created "on the
-fly." Each time you open a Scribus file that contains a Render
-Frame, Scribus will run the respective program that's necessary to
-render the content and create a temporary image file which will then
-be loaded into the frame. This is why Render Frames aren't listed in
-<i>Extras > Manage Images</i>.</p>
-<p>This behaviour has some
-consequences. While you can use a Scribus file with images on another
-computer by using <i>File > Collect for Output</i>
-and copying the resulting archive to another machine, Render Frames
-require the presence of the used <i>software</i>
-on this machine. Moreover, the feature might not work between
-different operating systems, because the command-line options can be
-different.</p>
-<p>Another limitation is that you can't apply any image effects to Render Frames.</p>
+<p>If you look at the Context Menu for Render Frames, you will get the impression that they are image frames. In a sense, that’s correct, as you can change the preview settings for Render Frames or update the content. There is, however, a major difference: As said above, the markup text ist stored within a Scribus file, and the rendered content is always created “on the fly.” Each time you open a Scribus file that contains a Render Frame, Scribus will run the program that’s necessary to render the content and create a temporary image file which will then be loaded into the frame. This is why Render Frames aren’t listed in <i>Extras > Manage Images</i>.</p>
+<p>This behavior has some consequences. While you can use a Scribus file with images on another computer by using <i>File > Collect for Output</i>
+and copying the resulting archive to another machine, Render Frames require the presence of the used <i>software</i> on this machine. Moreover, the feature might not work between different operating systems, because the command-line options can be different.</p>
+<p>Another limitation is that you can’t apply any image effects to Render Frames.</p>
-<h1>Configuration</h1>
-<p>To make Render Frames work, you need to have the required programs
-installed on your computer. By default, Scribus supports five
-programs, namely LaTeX, Lilypond, gnuplot, dot/Graphviz and Lilypond. On Linux,
-your package manager will take care about the installation and the
-dependencies of the software. On other platforms you might need to
-install the programs separately and edit some configuration files.</p>
-<p>If you open the tab "External Tools" in <i>File >
-Preferences</i>, you see the configuration options for Render Frames
-at the bottom of the dialog:</p>
+<h2>Configuration</h2>
+<p>To make Render Frames work, you need to have the required programs installed on your computer. By default, Scribus supports five programs, namely LaTeX, Lilypond, gnuplot, dot/Graphviz and Lilypond. On Linux, your package manager will take care about the installation and the dependencies of the software. On other platforms you might need to install the programs separately and edit some configuration files.</p>
+<p>If you open the tab “External Tools” in the Preferences, you see the configuration options for Render Frames at the bottom of the dialog:</p>
<table width="100%"><tr><td align="center"><img src="images/rf1.png"/></td></tr></table>
-<p>Under "Configurations," Scribus shows the default configuration files. Each program you want to use from within Scribus needs a separate configuration file. To add a new program to your Render Frames, you have to create an XML file with some required settings. Below you see an abridged and commented gnuplot configuration file, which will serve as an example:</p>
+<p>Under “Configurations,” Scribus shows the default configuration files. Each program you want to use from within Scribus needs a separate configuration file. To add a new program to your Render Frames, you have to create an XML file with some required settings. Below you see an abridged and commented gnuplot configuration file, which will serve as an example:</p>
<p><code><editorsettings description="Gnuplot" icon="gnuplot.png"></code> This line sets the description of the program, as well as the icon for the drop-down list in the Render Frame Editor. It must be stored in the same directory as the XML file. You can use PNG, XPM and SVG icons.</p>
<p><code><executable command="gnuplot"></code> This is the command-line call of the program. You can only use software that can work on the command-line. Also, the program needs to be able to create output in either PNG, PDF or EPS format. By default, Scribus uses the command-line options for Linux/UNIX systems.</p>
<p><code><imagefile extension=".png"/></code> Here you tell the editor which file format it has to expect from the external program.</p>
<p><code><highlighter> </highlighter></code> This part is mainly interesting for programmers, as it allows for the creation of indvidual syntax highlighting schemes by using Regular Expressions. For further information see: <a href="http://docs.kde.org/kde3/en/kdeutils/KRegExpEditor/index.html">http://docs.kde.org/kde3/en/kdeutils/KRegExpEditor/index.html</a> and <a href="http://doc.trolltech.com/4.4/qregexp.html">http://doc.trolltech.com/4.4/qregexp.html</a>.</p>
-<p><code><empty-frame-text></code> Here you can enter sample text in the
-markup language of the program you want to use, for instance:</p>
+<p><code><empty-frame-text></code> Here you can enter sample text in the markup language of the program you want to use, for instance:</p>
<p><code>plot sin(x), (cos(x))**2</code></p>
-</p><code><preamble></code> If the markup language you
-want to use requires a preamble, you can enter it here. It will not
-be displayed in the editor.</p>
-<p><code><postamble></code> If the markup language you
-want to use requires a postamble, you can enter it here. It will not
-be displayed in the editor.</p>
-<p><code><tab type="settings"></code> Here's where translations to existing GUI strings as well as new tabs or other UI elements can be added via simple XML entries, for example:</p>
+</p><code><preamble></code> If the markup language you want to use requires a preamble, you can enter it here. It will not be displayed in the editor.</p>
+<p><code><postamble></code> If the markup language you want to use requires a postamble, you can enter it here. It will not be displayed in the editor.</p>
+<p><code><tab type="settings"></code> Here’s where translations to existing GUI strings as well as new tabs or other UI elements can be added via simple XML entries, for example:</p>
<p><code><title><i18n></code>
<p6><code>
<ul>
<li><en>Ranges</en>
-<li><de>Bereiche</de>
+<li><de>Bereiche</de>.org.org.org
<li><fr>Rangées</fr>
<li><pl>Zakresy</pl>
<li><ru>Диапазоны</ru>
</ul></code></p6>
-<p>To add a new configuration file, click on the "Add..."
-button, which will bring up a file dialog. Select your file and click
-"Open." The file will then be added to your Render Frame
-configuration.</p>
-<p>By moving entries of XML configuration files in the list up or
-down, you can change the order of entries in the editor's drop down
-list. If you want to use a different XML configuration file for a
-particular markup language (for example, if you need another default
-preamble for LaTeX frames in a project), you can change the path to
-the alternative file by clicking on "Change ..." or simply add a new configuration file with an appropriate name, like "MyLateX".</p>
-<br>If you prefer another editor for your markup, for example if you can't live without Emacs or vi, or if the editor window is simply too small for you, you can override the built-in Scribus Render Frame Editor by using
-another editor like vi or Kate. Just insert the path to the
-executable file in the text field "External Editor." The external editor won't override the Render Frame editor: As soon as
-you save your markup from the external editor, Scribus "intercepts"
-the data and renders the output into the frame or will display error messages in the "Program Messages" field. The interception also
-means that any change to the markup text won't be saved anywhere but
-in your Scribus file. If you haven't specified an external editor in <i>Preferences < Tools</i>, Scribus will display an error message:</p>
+<p>To add a new configuration file, click on the “Add …” button, which will bring up a file dialog. Select your file and click “Open.” The file will then be added to your Render Frame configuration.</p>
+<p>By moving entries of XML configuration files in the list up or down, you can change the order of entries in the editor’s drop down list. If you want to use a different XML configuration file for a particular markup language (for example, if you need another default preamble for LaTeX frames in a project), you can change the path to the alternative file by clicking on “Change …” or simply add a new configuration file with an appropriate name, like “MyLateX.”</p>
+<br>If you prefer another editor for your markup, for example if you can’t live without Emacs or vi, or if the editor window is simply too small for you, you can override the built-in Scribus Render Frame Editor by using another editor like vi or Kate. Just insert the path to the executable file in the text field “External Editor.” The external editor won’t override the Render Frame editor: As soon as you save your markup from the external editor, Scribus “intercepts” the data and renders the output into the frame or will display error messages in the “Program Messages” field. The interception also means that any change to the markup text won’t be saved anywhere but in your Scribus file. If you haven’t specified an external editor in <i>Preferences < Tools</i>, Scribus will display an error message:</p>
<br></br>
<table width="100%"><tr><td align="center"><img src="images/rf-error3.png"/></td></tr></table>
<br></br>
-<p>In addition, you have the option to start with an empty frame. By checking
-"Force DPI," Scribus will render the output of every Render Frame with the resolution
-set in the spinbox to the right. It's set to 72 dpi by default for
-performance reasons. If you want to produce a document for
-professional printing, you will want to choose a higher resolution.</p>
+<p>In addition, you have the option to start with an empty frame. By checking “Force DPI,” Scribus will render the output of every Render Frame with the resolution set in the spinbox to the right. It's set to 72 dpi by default for performance reasons. If you want to produce a document for professional printing, you will want to choose a higher resolution.</p>
</body>
</html>
Modified: trunk/Scribus/doc/en/scripter1.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=16853&path=/trunk/Scribus/doc/en/scripter1.html
==============================================================================
--- trunk/Scribus/doc/en/scripter1.html (original)
+++ trunk/Scribus/doc/en/scripter1.html Tue Sep 20 20:14:09 2011
@@ -6,26 +6,23 @@
<body>
<h2>Scripting Scribus with Python</h2>
-<h4>Overview</h4>
-<p>This is the description how to use the Scripting Plugin for Scribus. The scripter allows you to use the powerful Python Language as a scripting language in Scribus. This can allow you to automate otherwise repetitive tasks among other features. </p>
+<h3>Overview</h3>
+<p>This is the description how to use the scripting plug-in for Scribus. The Scripter allows you to use the powerful Python programming language as a scripting language in Scribus. This can help you to automate otherwise repetitive tasks or add new features.</p>
-<p>This manual is the first version, by no means complete or fully accurate. Addtions to the scripter are made frequently, so a short note to the mailing list is in order ifyou have questions.</p>
+<p>Note that additions to the Scripter are being made frequently, which means that the available documentation may be incomplete.</p>
-<p>There are some simple example scripts in the samples subdirectory where Scribus is installed. If you have created scripts which would be useful for other users, please feel free to upload it to www.scribus.net or mail mrdocs at scribus.info with an attachment. We hope to add a plug-in gallery to the main website in the future. </p>
-<h3>Using the Plugin</h3>
+<h3>Using the Plug-in</h3>
+<p>Scribus is being shipped with some “hard-wired” scripts, which are available via <i>Scripter > Scribus Scripts</i>:</p>
<table width="100%"><tr><td align="center"><img src="images/Scripter.png" align="center" alt="Running a script" title="Running a script" /></td></tr></table>
-<p>To execute a Python Script select "Script->Execute Script..." Scribus will display a File select Box which allows you to select a Python Script. Below that, there is a menu item "Recent Scripts" where the most recently run scripts are listed. The number listed depends on your preferences setting. </p>
+<p>There are some simple example scripts in the subdirectory “samples.” Its location depends on the operating system you use, e.g. <code>/usr/local/share/scribus</code> or <code>/usr/share/scribus</code> on Linux. If you have created a script which you think could be useful for others, please feel free to add it to the <a href="http://wiki.scribus.net/">Scribus Wiki</a> or paste it into an email and send it to the <a href="http://lists.scribus.info/mailman/listinfo/scribus/">Scribus mailing list</a>.</p>
-<p>You can use many Python modules with this Plugin. The only exception are scripts who expect parameters from the command Line. They won't work because the plugin gives the Python interpreter an empty command line.</p>
+<p>To execute an external Python script, you have to use <i>Script > Execute Script</i>. Scribus will open a file dialog, which allows you to select a Python script (file extension: *.py). <i>Script > Recent Scripts</i> shows a list of recently executed scripts.</p>
-<p>The menu item "Show Console" gives you an interactive Python console, where you can execute commands directly. There is no need to do a "from scribus import *", this has already been done. You can use all the following commands in the Scripter API section directly without any prefix.</p>
+<p>You can use many Python modules with this plug-in, the only exception being scripts that expect parameters from the command Line. These won’t work because the plug-in gives the Python interpreter an empty command line.</p>
-<p>You can findsome useful information about any script calling "Script->About Script...".</p>
-
-<p>You can display the full Scripter reference manual when you select "Help->Scripter Manual...".</p>
-
+<p>The menu entry <i>Script > Show Console</i> will launch an interactive Python console, where you can execute commands directly. There is no need to use “<code>from scribus import *</code>”, as this has already been done. You can use all the commands listed in the following pages of the Scripter API documentation directly without any prefix.</p>
</body>
</html>
More information about the scribus-commit
mailing list