r22948 by jghali - Move scripter style creation functions into their own documentation page
scribus-commit
scribus-commit at lists.scribus.net
Sat Apr 13 16:30:11 UTC 2019
Author: jghali
Date: Sat Apr 13 16:30:11 2019
New Revision: 22948
URL: http://scribus.net/websvn/listing.php?repname=Scribus&sc=1&rev=22948
Log:
Move scripter style creation functions into their own documentation page
Added:
trunk/Scribus/doc/de/scripterapi-styles.html
trunk/Scribus/doc/en/scripterapi-styles.html
trunk/Scribus/doc/fr/scripterapi-styles.html
trunk/Scribus/doc/it/scripterapi-styles.html
Modified:
trunk/Scribus/doc/de/menu.xml
trunk/Scribus/doc/de/scripterapi-object.html
trunk/Scribus/doc/en/menu.xml
trunk/Scribus/doc/en/scripterapi-object.html
trunk/Scribus/doc/fr/menu.xml
trunk/Scribus/doc/fr/scripterapi-object.html
trunk/Scribus/doc/it/menu.xml
trunk/Scribus/doc/it/scripterapi-object.html
Modified: trunk/Scribus/doc/de/menu.xml
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=22948&path=/trunk/Scribus/doc/de/menu.xml
==============================================================================
--- trunk/Scribus/doc/de/menu.xml (original)
+++ trunk/Scribus/doc/de/menu.xml Sat Apr 13 16:30:11 2019
@@ -126,6 +126,7 @@
<submenuitem text="Setting Object Properties" file="scripterapi-setobjprop.html"/>
<submenuitem text="Getting Object Properties" file="scripterapi-getobjprop.html"/>
<submenuitem text="Manipulating Objects" file="scripterapi-manobj.html"/>
+ <submenuitem text="Creating & Manipulating Styles" file="scripterapi-styles.html"/>
<submenuitem text="Handling Text Frames" file="scripterapi-textframes.html"/>
<submenuitem text="Color Commands" file="scripterapi-color.html"/>
<submenuitem text="Font Commands" file="scripterapi-font.html"/>
Modified: trunk/Scribus/doc/de/scripterapi-object.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=22948&path=/trunk/Scribus/doc/de/scripterapi-object.html
==============================================================================
--- trunk/Scribus/doc/de/scripterapi-object.html (original)
+++ trunk/Scribus/doc/de/scripterapi-object.html Sat Apr 13 16:30:11 2019
@@ -16,118 +16,6 @@
<p>Creates a new bezier curve and returns its name. The points for the bezier curve are stored in the list "list" in the following order: [x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn] In the points list, x and y mean the x and y coordinates of the point and kx and ky meaning the control point for the curve. The coordinates are given in the current measurement units of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further access to that object. If "name" is not given Scribus will create one for you.</p>
<p>May raise <a href="scripterapi.html#NameExistsError">NameExistsError</a> if you explicitly pass a name that's already used. May raise ValueError if an insufficient number of points is passed or if the number of values passed don't group into points without leftovers.</p></dd>
-<dt><a name="-createCharStyle"><strong>createCharStyle</strong></a>(...)</dt>
-<dd><code>createCharStyle(...)</code>
-<p>Creates a character style. This function takes the following keyword parameters:
-<ul>
-<li>"name" [required] -> name of the char style to create (first parameter)</li>
-<li>"font" [optional] -> name of the font to use (second parameter)</li>
-<li>fontsize [optional] -> font size to set (double) (third parameter)</li>
-<li>"features" [optional] -> nearer typographic details can be defined by a string that might contain the following phrases comma-separated (without spaces!) (fourth parameter - a string):
-<ul>
- <li>inherit</li>
- <li>bold</li>
- <li>italic</li>
- <li>underline</li>
- <li>underlinewords</li>
- <li>strike</li>
- <li>superscript</li>
- <li>subscript</li>
- <li>outline</li>
- <li>shadowed</li>
- <li>allcaps</li>
- <li>smallcaps</li>
-</ul>
-</li>
-<li>"fillcolor" [optional], fillshade [optional] -> specify fill options (5th parameter: string, 6th parameter: a float 1.0 = 100%)</li>
-<li>"strokecolor" [optional], strokeshade [optional] -> specify stroke options (7th parameter: string, 8th parameter: a float 1.0 = 100%)</li>
-<li>baselineoffset [optional] -> offset of the baseline (ninth parameter)</li>
-<li>shadowxoffset [optional], shadowyoffset [optional] -> offset of the shadow if used (10th and 11th parameters)</li>
-<li>outlinewidth [optional] -> width of the outline if used (12th parameter)</li>
-<li>underlineoffset [optional], underlinewidth [optional] -> underline options if used (13th and 14th parameters)</li>
-<li>strikethruoffset [optional], strikethruwidth [optional] -> strikethru options if used (15th and 16th parameters)</li>
-<li>scaleh [optional], scalev [optional] -> scale of the chars (17th and 18th parameters - float values, 1.0 = 100%)</li>
-<li>tracking [optional] -> tracking of the text (19th parameter - number with odd math, e.g. -50 = -5.0%)</li>
-<li>"language" [optional] -> language code (20th parameter - a string en = English)</li>
-<li>"fontfeatures" [optional] -> a string that contains a comma-separated list of OpenType font features (21th parameter - a string):
-<ul>
- <li>Ligatures:
- <ul>
- <li>-liga: disable common ligatures</li>
- <li>-clig: disable contextual ligatures</li>
- <li>+dlig: enable discretionary ligatures</li>
- <li>+hlig: enable historical ligatures</li>
- </ul>
- </li>
- <li>Script Position:
- <ul>
- <li>+subs: enable subscript</li>
- <li>+sups: enable superscript</li>
- <li>+ordn: enable ordinals</li>
- </ul>
- </li>
- <li>Capitals:
- <ul>
- <li>+smcp: enable small capitals</li>
- <li>+c2sc: enable small capitals from capitals</li>
- <li>+pcap: enable petite capitals</li>
- <li>+c2pc: enable petite capitals from capitals</li>
- <li>+unic: enable unicase</li>
- <li>+titl: enable titling</li>
- </ul>
- </li>
- <li>Numerals:
- <ul>
- <li>+lnum: enable lining figures</li>
- <li>+tnum: enable old style numerals</li>
- </ul>
- </li>
- <li>Numeral Width:
- <ul>
- <li>+pnum: enable proportional figures</li>
- <li>+tnum: enable tabular figures</li>
- </ul>
- </li>
- <li>Numeral Fractions:
- <ul>
- <li>+frac: enable diagonal fractions</li>
- <li>+afrc: enable stacked fractions</li>
- </ul>
- </li>
- <li>Numeral zero:
- <ul>
- <li>+zero: enable slashed zero</li>
- </ul>
- </li>
- <li>Style sets:
- <ul>
- <li>+ss01: enable 1st style set</li>
- <li>...</li>
- <li>+ss20: enable 20th style set</li>
- </ul>
- </li>
-</ul>
-</li>
-</ul>
-</p>
-<p>On a practical level, this is a challenging command to fully understand if you wish to assign a number of settings, since keeping track of where you are, and which kind of entry is needed (string vs number) is not easy. For some guidance on this showing in particular how to set tracking, see the wiki page <a href="https://wiki.scribus.net/canvas/Text_and_Text_Manipulation">Text and Text Manipulation</a>.</p>
-</dd>
-
-<dt><a name="-createCustomLineStyle"><strong>createCustomLineStyle</strong></a>(...)</dt>
-<dd><code>createCustomLineStyle(styleName, style)</code>
-<p>Creates the custom line style 'styleName'.</p>
-<p>This function takes list of dictionary as parameter for "style". Each dictionary represent one subline within style. Dictionary can have those keys:
-<ul>
-<li>Color [optional] -> name of the color to use (string)</li>
-<li>Dash [optional] -> type of line to use (integer)</li>
-<li>LineEnd [optional] -> type of LineEnd to use (integer)</li>
-<li>LineJoin [optional] -> type of LineJoin to use (integer)</li>
-<li>Shade [optional] -> opacity of line (integer)</li>
-<li>Width [optional] -> width of line (double)</li>
-</ul>
-</p>
-</dd>
-
<dt><a name="-createEllipse"><strong>createEllipse</strong></a>(...)</dt>
<dd><code>createEllipse(x, y, width, height, ["name"]) -> string</code>
<p>Creates a new ellipse on the current page and returns its name. The coordinates are given in the current measurement units of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further referencing of that object. If "name" is not given Scribus will create one for you.</p>
@@ -142,43 +30,6 @@
<dd><code>createLine(x1, y1, x2, y2, ["name"]) -> string</code>
<p>Creates a new line from the point(x1, y1) to the point(x2, y2) and returns its name. The coordinates are given in the current measurement unit of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further access to that object. If "name" is not given Scribus will create one for you.</p>
<p>May raise <a href="scripterapi.html#NameExistsError">NameExistsError</a> if you explicitly pass a name that's already used.</p></dd>
-
-<dt><a name="-createParagraphStyle"><strong>createParagraphStyle</strong></a>(...)</dt>
-<dd><code>createParagraphStyle(...)</code>
-<p>Creates a paragraph style. This function takes the following keyword parameters:
-<ul>
-<li>"name" [required] -> specifies the name of the paragraphstyle to create</li>
-<li>linespacingmode [optional] -> specifies the linespacing mode; possible modes are:
-<ul>
- <li>fixed linespacing: 0</li>
- <li>automatic linespacing: 1</li>
- <li>baseline grid linespacing: 2</li>
-</ul>
-</li>
-<li>linespacing [optional] -> specifies the linespacing if using fixed linespacing</li>
-<li>alignment [optional] -> specifies the alignment of the paragraph
-<ul>
- <li>left: 0</li>
- <li>center: 1</li>
- <li>right: 2</li>
- <li>justify: 3</li>
- <li>extend: 4</li>
-</ul>
-</li>
-<li>leftmargin [optional], rightmargin [optional] -> specify the margin</li>
-<li>gapbefore [optional], gapafter [optional] -> specify the gaps to the heading and following paragraphs</li>
-<li>firstindent [optional] -> the indent of the first line</li>
-<li>hasdropcap [optional] -> specifies if there are caps (1 = yes, 0 = no)</li>
-<li>dropcaplines [optional] -> height (in lines) of the caps if used</li>
-<li>dropcapoffset [optional] -> offset of the caps if used</li>
-<li>"charstyle" [optional] -> char style to use</li>
-</ul>
-</p>
-<p>If you wish to skip a number of settings, unfortunately, this command will not accept null values, i.e., a series of commas. You <i>must</i> put some integer value for each of the potential parameters. For example, imagine you wish to only specify a name for the Paragraph Style, and the Character Style. Your command should be something like:</p>
-<p><strong>scribus.createParagraphStyle("MyNewStyle",0,0,0,0,0,0,0,0,0,"MyCharStyle")</strong></p>
-<p>On the other hand, if you only wanted to specify a name and linespacing mode, you can quit whenever after you finished with non-zero data:</p>
-<p><strong>scribus.createParagraphStyle("MyOtherNewStyle",1)</strong></p>
-</dd>
<dt><a name="-createPathText"><strong>createPathText</strong></a>(...)</dt>
<dd><code>createPathText(x, y, "textbox", "beziercurve", ["name"]) -> string</code>
@@ -210,18 +61,6 @@
<dd><code>deleteObject(["name"])</code>
<p>Deletes the item with the name "name". If "name" is not given the currently selected item is deleted.</p></dd>
-<dt><a name="-getAllStyles"><strong>getAllStyles</strong></a>(...)</dt>
-<dd><code>getAllStyles() -> list</code>
-<p>Deprecated, use getParagraphStyles() instead.</p></dd>
-
-<dt><a name="-getCharStyles"><strong>getCharStyles</strong></a>(...)</dt>
-<dd><code>getCharStyles() -> list</code>
-<p>Return a list of the names of all character styles in the current document.</p></dd>
-
-<dt><a name="-getParagraphStyles"><strong>getParagraphStyles</strong></a>(...)</dt>
-<dd><code>getParagraphStyles() -> list</code>
-<p>Return a list of the names of all paragraph styles in the current document.</p></dd>
-
<dt><a name="-objectExists"><strong>objectExists</strong></a>(...)</dt>
<dd><code>objectExists(["name"]) -> bool</code>
<p>Test if an object with specified name really exists in the document. The optional parameter is the object name. When no object name is given, returns True if there is something selected.</p></dd>
Modified: trunk/Scribus/doc/en/menu.xml
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=22948&path=/trunk/Scribus/doc/en/menu.xml
==============================================================================
--- trunk/Scribus/doc/en/menu.xml (original)
+++ trunk/Scribus/doc/en/menu.xml Sat Apr 13 16:30:11 2019
@@ -126,6 +126,7 @@
<submenuitem text="Setting Object Properties" file="scripterapi-setobjprop.html"/>
<submenuitem text="Getting Object Properties" file="scripterapi-getobjprop.html"/>
<submenuitem text="Manipulating Objects" file="scripterapi-manobj.html"/>
+ <submenuitem text="Creating & Manipulating Styles" file="scripterapi-styles.html"/>
<submenuitem text="Handling Text Frames" file="scripterapi-textframes.html"/>
<submenuitem text="Commands for Images & Vectors" file="scripterapi-images.html"/>
<submenuitem text="Commands for Lines" file="scripterapi-lines.html"/>
Modified: trunk/Scribus/doc/en/scripterapi-object.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=22948&path=/trunk/Scribus/doc/en/scripterapi-object.html
==============================================================================
--- trunk/Scribus/doc/en/scripterapi-object.html (original)
+++ trunk/Scribus/doc/en/scripterapi-object.html Sat Apr 13 16:30:11 2019
@@ -16,118 +16,6 @@
<p>Creates a new bezier curve and returns its name. The points for the bezier curve are stored in the list "list" in the following order: [x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn] In the points list, x and y mean the x and y coordinates of the point and kx and ky meaning the control point for the curve. The coordinates are given in the current measurement units of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further access to that object. If "name" is not given Scribus will create one for you.</p>
<p>May raise <a href="scripterapi.html#NameExistsError">NameExistsError</a> if you explicitly pass a name that's already used. May raise ValueError if an insufficient number of points is passed or if the number of values passed don't group into points without leftovers.</p></dd>
-<dt><a name="-createCharStyle"><strong>createCharStyle</strong></a>(...)</dt>
-<dd><code>createCharStyle(...)</code>
-<p>Creates a character style. This function takes the following keyword parameters:
-<ul>
-<li>"name" [required] -> name of the char style to create (first parameter)</li>
-<li>"font" [optional] -> name of the font to use (second parameter)</li>
-<li>fontsize [optional] -> font size to set (double) (third parameter)</li>
-<li>"features" [optional] -> nearer typographic details can be defined by a string that might contain the following phrases comma-separated (without spaces!) (fourth parameter - a string):
-<ul>
- <li>inherit</li>
- <li>bold</li>
- <li>italic</li>
- <li>underline</li>
- <li>underlinewords</li>
- <li>strike</li>
- <li>superscript</li>
- <li>subscript</li>
- <li>outline</li>
- <li>shadowed</li>
- <li>allcaps</li>
- <li>smallcaps</li>
-</ul>
-</li>
-<li>"fillcolor" [optional], fillshade [optional] -> specify fill options (5th parameter: string, 6th parameter: a float 1.0 = 100%)</li>
-<li>"strokecolor" [optional], strokeshade [optional] -> specify stroke options (7th parameter: string, 8th parameter: a float 1.0 = 100%)</li>
-<li>baselineoffset [optional] -> offset of the baseline (ninth parameter)</li>
-<li>shadowxoffset [optional], shadowyoffset [optional] -> offset of the shadow if used (10th and 11th parameters)</li>
-<li>outlinewidth [optional] -> width of the outline if used (12th parameter)</li>
-<li>underlineoffset [optional], underlinewidth [optional] -> underline options if used (13th and 14th parameters)</li>
-<li>strikethruoffset [optional], strikethruwidth [optional] -> strikethru options if used (15th and 16th parameters)</li>
-<li>scaleh [optional], scalev [optional] -> scale of the chars (17th and 18th parameters - float values, 1.0 = 100%)</li>
-<li>tracking [optional] -> tracking of the text (19th parameter - number with odd math, e.g. -50 = -5.0%)</li>
-<li>"language" [optional] -> language code (20th parameter - a string en = English)</li>
-<li>"fontfeatures" [optional] -> a string that contains a comma-separated list of OpenType font features (21th parameter - a string):
-<ul>
- <li>Ligatures:
- <ul>
- <li>-liga: disable common ligatures</li>
- <li>-clig: disable contextual ligatures</li>
- <li>+dlig: enable discretionary ligatures</li>
- <li>+hlig: enable historical ligatures</li>
- </ul>
- </li>
- <li>Script Position:
- <ul>
- <li>+subs: enable subscript</li>
- <li>+sups: enable superscript</li>
- <li>+ordn: enable ordinals</li>
- </ul>
- </li>
- <li>Capitals:
- <ul>
- <li>+smcp: enable small capitals</li>
- <li>+c2sc: enable small capitals from capitals</li>
- <li>+pcap: enable petite capitals</li>
- <li>+c2pc: enable petite capitals from capitals</li>
- <li>+unic: enable unicase</li>
- <li>+titl: enable titling</li>
- </ul>
- </li>
- <li>Numerals:
- <ul>
- <li>+lnum: enable lining figures</li>
- <li>+tnum: enable old style numerals</li>
- </ul>
- </li>
- <li>Numeral Width:
- <ul>
- <li>+pnum: enable proportional figures</li>
- <li>+tnum: enable tabular figures</li>
- </ul>
- </li>
- <li>Numeral Fractions:
- <ul>
- <li>+frac: enable diagonal fractions</li>
- <li>+afrc: enable stacked fractions</li>
- </ul>
- </li>
- <li>Numeral zero:
- <ul>
- <li>+zero: enable slashed zero</li>
- </ul>
- </li>
- <li>Style sets:
- <ul>
- <li>+ss01: enable 1st style set</li>
- <li>...</li>
- <li>+ss20: enable 20th style set</li>
- </ul>
- </li>
-</ul>
-</li>
-</ul>
-</p>
-<p>On a practical level, this is a challenging command to fully understand if you wish to assign a number of settings, since keeping track of where you are, and which kind of entry is needed (string vs number) is not easy. For some guidance on this showing in particular how to set tracking, see the wiki page <a href="https://wiki.scribus.net/canvas/Text_and_Text_Manipulation">Text and Text Manipulation</a>.</p>
-</dd>
-
-<dt><a name="-createCustomLineStyle"><strong>createCustomLineStyle</strong></a>(...)</dt>
-<dd><code>createCustomLineStyle(styleName, style)</code>
-<p>Creates the custom line style 'styleName'.</p>
-<p>This function takes list of dictionary as parameter for "style". Each dictionary represent one subline within style. Dictionary can have those keys:
-<ul>
-<li>Color [optional] -> name of the color to use (string)</li>
-<li>Dash [optional] -> type of line to use (integer)</li>
-<li>LineEnd [optional] -> type of LineEnd to use (integer)</li>
-<li>LineJoin [optional] -> type of LineJoin to use (integer)</li>
-<li>Shade [optional] -> opacity of line (integer)</li>
-<li>Width [optional] -> width of line (double)</li>
-</ul>
-</p>
-</dd>
-
<dt><a name="-createEllipse"><strong>createEllipse</strong></a>(...)</dt>
<dd><code>createEllipse(x, y, width, height, ["name"]) -> string</code>
<p>Creates a new ellipse on the current page and returns its name. The coordinates are given in the current measurement units of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further referencing of that object. If "name" is not given Scribus will create one for you.</p>
@@ -142,43 +30,6 @@
<dd><code>createLine(x1, y1, x2, y2, ["name"]) -> string</code>
<p>Creates a new line from the point(x1, y1) to the point(x2, y2) and returns its name. The coordinates are given in the current measurement unit of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further access to that object. If "name" is not given Scribus will create one for you.</p>
<p>May raise <a href="scripterapi.html#NameExistsError">NameExistsError</a> if you explicitly pass a name that's already used.</p></dd>
-
-<dt><a name="-createParagraphStyle"><strong>createParagraphStyle</strong></a>(...)</dt>
-<dd><code>createParagraphStyle(...)</code>
-<p>Creates a paragraph style. This function takes the following keyword parameters:
-<ul>
-<li>"name" [required] -> specifies the name of the paragraphstyle to create</li>
-<li>linespacingmode [optional] -> specifies the linespacing mode; possible modes are:
-<ul>
- <li>fixed linespacing: 0</li>
- <li>automatic linespacing: 1</li>
- <li>baseline grid linespacing: 2</li>
-</ul>
-</li>
-<li>linespacing [optional] -> specifies the linespacing if using fixed linespacing</li>
-<li>alignment [optional] -> specifies the alignment of the paragraph
-<ul>
- <li>left: 0</li>
- <li>center: 1</li>
- <li>right: 2</li>
- <li>justify: 3</li>
- <li>extend: 4</li>
-</ul>
-</li>
-<li>leftmargin [optional], rightmargin [optional] -> specify the margin</li>
-<li>gapbefore [optional], gapafter [optional] -> specify the gaps to the heading and following paragraphs</li>
-<li>firstindent [optional] -> the indent of the first line</li>
-<li>hasdropcap [optional] -> specifies if there are caps (1 = yes, 0 = no)</li>
-<li>dropcaplines [optional] -> height (in lines) of the caps if used</li>
-<li>dropcapoffset [optional] -> offset of the caps if used</li>
-<li>"charstyle" [optional] -> char style to use</li>
-</ul>
-</p>
-<p>If you wish to skip a number of settings, unfortunately, this command will not accept null values, i.e., a series of commas. You <i>must</i> put some integer value for each of the potential parameters. For example, imagine you wish to only specify a name for the Paragraph Style, and the Character Style. Your command should be something like:</p>
-<p><strong>scribus.createParagraphStyle("MyNewStyle",0,0,0,0,0,0,0,0,0,"MyCharStyle")</strong></p>
-<p>On the other hand, if you only wanted to specify a name and linespacing mode, you can quit whenever after you finished with non-zero data:</p>
-<p><strong>scribus.createParagraphStyle("MyOtherNewStyle",1)</strong></p>
-</dd>
<dt><a name="-createPathText"><strong>createPathText</strong></a>(...)</dt>
<dd><code>createPathText(x, y, "textbox", "beziercurve", ["name"]) -> string</code>
@@ -210,18 +61,6 @@
<dd><code>deleteObject(["name"])</code>
<p>Deletes the item with the name "name". If "name" is not given the currently selected item is deleted.</p></dd>
-<dt><a name="-getAllStyles"><strong>getAllStyles</strong></a>(...)</dt>
-<dd><code>getAllStyles() -> list</code>
-<p>Deprecated, use getParagraphStyles() instead.</p></dd>
-
-<dt><a name="-getCharStyles"><strong>getCharStyles</strong></a>(...)</dt>
-<dd><code>getCharStyles() -> list</code>
-<p>Return a list of the names of all character styles in the current document.</p></dd>
-
-<dt><a name="-getParagraphStyles"><strong>getParagraphStyles</strong></a>(...)</dt>
-<dd><code>getParagraphStyles() -> list</code>
-<p>Return a list of the names of all paragraph styles in the current document.</p></dd>
-
<dt><a name="-objectExists"><strong>objectExists</strong></a>(...)</dt>
<dd><code>objectExists(["name"]) -> bool</code>
<p>Test if an object with specified name really exists in the document. The optional parameter is the object name. When no object name is given, returns True if there is something selected.</p></dd>
Modified: trunk/Scribus/doc/fr/menu.xml
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=22948&path=/trunk/Scribus/doc/fr/menu.xml
==============================================================================
--- trunk/Scribus/doc/fr/menu.xml (original)
+++ trunk/Scribus/doc/fr/menu.xml Sat Apr 13 16:30:11 2019
@@ -107,6 +107,7 @@
<submenuitem text="Définition des propriétés de l'objet" file="scripterapi-setobjprop.html"/>
<submenuitem text="Définition des propriétés de l'objet" file="scripterapi-getobjprop.html"/>
<submenuitem text="Manipulation des objets" file="scripterapi-manobj.html"/>
+ <submenuitem text="Création et manipulation des styles" file="scripterapi-styles.html"/>
<submenuitem text="Manipulation des cadres de texte" file="scripterapi-textframes.html"/>
<submenuitem text="Commandes de traitement des couleurs" file="scripterapi-color.html"/>
<submenuitem text="Commandes de traitement des polices" file="scripterapi-font.html"/>
Modified: trunk/Scribus/doc/fr/scripterapi-object.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=22948&path=/trunk/Scribus/doc/fr/scripterapi-object.html
==============================================================================
--- trunk/Scribus/doc/fr/scripterapi-object.html (original)
+++ trunk/Scribus/doc/fr/scripterapi-object.html Sat Apr 13 16:30:11 2019
@@ -22,118 +22,6 @@
générer ValueError si le nombre de points précisé est insuffisant
ou si le nombre de valeurs passées ne forme pas un groupe de points
entier, sans reste.</p></dd>
-
-<dt><a name="-createCharStyle"><strong>createCharStyle</strong></a>(...)</dt>
-<dd><code>createCharStyle(...)</code>
-<p>Crée un style de caractère. Cette function accepte les paramètres nommés suivants:
-<ul>
-<li>"name" [requis] -> nom du style de caractère à créer (premier paramètre)</li>
-<li>"font" [optionnel] -> nom de la police de caractère à utiliser (second paramètre)</li>
-<li>fontsize [optionnel] -> taille de la police de caractère (3ème paramètre - nombre réel)</li>
-<li>"features" [optionnel] -> détails typographiques définis sous la forme d'une liste d'éléments séparés par des virgules (sans espaces!), pris parmis les éléments suivants (4ème paramètre - chaîne de caractère):
-<ul>
- <li>inherit</li>
- <li>bold</li>
- <li>italic</li>
- <li>underline</li>
- <li>underlinewords</li>
- <li>strike</li>
- <li>superscript</li>
- <li>subscript</li>
- <li>outline</li>
- <li>shadowed</li>
- <li>allcaps</li>
- <li>smallcaps</li>
-</ul>
-</li>
-<li>"fillcolor" [optionnel], fillshade [optionnel] -> définie la couleur et la teinte de fond (5ème paramètre: chaîne, 6ème paramètre: nombre réel 1.0 = 100%)</li>
-<li>"strokecolor" [optionnel], strokeshade [optionnel] -> définie la couleur et la teinte de filet (7ème paramètre: chaîne, 8ème paramètre: nombre réel 1.0 = 100%)</li>
-<li>baselineoffset [optionnel] -> décalage par rapport à la ligne de base(9ème paramètre)</li>
-<li>shadowxoffset [optionnel], shadowyoffset [optionnel] -> décalages de l'ombre portée si celle-ci est utilisée(10ème et 11ème paramètres)</li>
-<li>outlinewidth [optionnel] -> largeur du filet si celui-ci est utilisé (12ème paramètre)</li>
-<li>underlineoffset [optionnel], underlinewidth [optionnel] -> options de soulignement si utilisé (13ème et 14ème paramètres)</li>
-<li>strikethruoffset [optionnel], strikethruwidth [optionnel] -> options de barré si utilisé (15ème et 16ème paramètres)</li>
-<li>scaleh [optionnel], scalev [optionnel] -> échelle horizontale et verticale des caractères (17ème et 18ème paramètres - nombres réels, 1.0 = 100%)</li>
-<li>tracking [optionnel] -> valeur d'approche du texte(19ème paramètre - nombre réel, e.g. -50 = -5.0%)</li>
-<li>"language" [optionnel] -> code de language (20ème paramètre - chaîne de caractère: en = English)</li>
-<li>"fontfeatures" [optionnel] -> chaîne de caractère contenant une liste de fonctionnalités OpenType séparées par des virgules (21ème paramètre):
-<ul>
- <li>Ligatures:
- <ul>
- <li>-liga: désactive les ligatures commmunes</li>
- <li>-clig: désactive les ligatures contextuelles</li>
- <li>+dlig: active les ligatures discrétionnaires</li>
- <li>+hlig: active les ligatures historiques</li>
- </ul>
- </li>
- <li>Script Position:
- <ul>
- <li>+subs: active les indices</li>
- <li>+sups: active les exposants</li>
- <li>+ordn: active les ordinaux</li>
- </ul>
- </li>
- <li>Capitals:
- <ul>
- <li>+smcp: active les petites capitales</li>
- <li>+c2sc: active les capitales en petites capitales</li>
- <li>+pcap: active les petite caps</li>
- <li>+c2pc: active les capitales en les petite caps</li>
- <li>+unic: active l'écriture unicamérale</li>
- <li>+titl: active le titrage</li>
- </ul>
- </li>
- <li>Numerals:
- <ul>
- <li>+lnum: active les chiffres alignés</li>
- <li>+tnum: active les chiffres en style ancien</li>
- </ul>
- </li>
- <li>Numeral Width:
- <ul>
- <li>+pnum: active la largeur de chiffre proportionnelle</li>
- <li>+tnum: active la largeur de chiffre tabulaire</li>
- </ul>
- </li>
- <li>Numeral Fractions:
- <ul>
- <li>+frac: active les fractions diagonales</li>
- <li>+afrc: active les fractions empilées</li>
- </ul>
- </li>
- <li>Numeral zero:
- <ul>
- <li>+zero: active le zéro barré</li>
- </ul>
- </li>
- <li>Jeux de styles:
- <ul>
- <li>+ss01: active le 1er jeu de style</li>
- <li>...</li>
- <li>+ss20: active le 20ème jeu de style</li>
- </ul>
- </li>
-</ul>
-</li>
-</ul>
-</p>
-<p>On a practical level, this is a challenging command to fully understand if you wish to assign a number of settings, since keeping track of where you are, and which kind of entry is needed (string vs number) is not easy. For some guidance on this showing in particular how to set tracking, see the wiki page <a href="https://wiki.scribus.net/canvas/Text_and_Text_Manipulation">Text and Text Manipulation</a>.</p>
-</dd>
-
-<dt><a name="-createCustomLineStyle"><strong>createCustomLineStyle</strong></a>(...)</dt>
-<dd><code>createCustomLineStyle(nomStyle, style)</code>
-<p>Crée le style de filet personnalisé 'nomStyle'.</p>
-<p>Cette fonction accepte une liste de dictonnaires en tant que paramètre du style. Chaque dictionnaire représente un sous-filet du style et accepte les clés suivantes:
-<ul>
-<li>Color [optionnel] -> nom de la couleur à utiliser (chaîne)</li>
-<li>Dash [optionnel] -> type de ligne à utiliser (entier)</li>
-<li>LineEnd [optionnel] -> type de fin de filet à utiliser (entier)</li>
-<li>LineJoin [optionnel] -> type de jointure de filet à utiliser (entier)</li>
-<li>Shade [optionnel] -> teinte de couleur (entier)</li>
-<li>Width [optionnel] -> largeur de filet (nombre réel entier)</li>
-</ul>
-</p>
-</dd>
<dt><a name="-createEllipse"><strong>createEllipse</strong></a>(...)</dt>
<dd><tt>createEllipse(x, y, largeur, hauteur, ["nom"]) -> chaîne</tt>
@@ -189,18 +77,6 @@
<p>Supprime l'élément portant le nom "nom". Si "nom" n'est pas
fourni, l'élément sélectionné est supprimé.</p></dd>
-<dt><a name="-getAllStyles"><strong>getAllStyles</strong></a>(...)</dt>
-<dd><tt>getAllStyles() -> liste</tt>
-<p>Obsolète. Veuillez utiliser getParagraphStyles() en lieu et place.</p></dd>
-
-<dt><a name="-getCharStyles"><strong>getCharStyles</strong></a>(...)</dt>
-<dd><tt>getCharStyles() -> liste</tt>
-<p>Retourne une liste des noms de l'ensemble des styles de caractère du document courant.</p></dd>
-
-<dt><a name="-getParagraphStyles"><strong>getParagraphStyles</strong></a>(...)</dt>
-<dd><tt>getParagraphStyles() -> liste</tt>
-<p>Retourne une liste des noms de l'ensemble des styles de paragraphe du document courant.</p></dd>
-
<dt><a name="-objectExists"><strong>objectExists</strong></a>(...)</dt>
<dd><tt>objectExists(["nom"]) -> booléen</tt>
<p>Teste si un objet avec le nom spécifié existe réellement dans le document. Le paramètre optionnel est le nom de l'objet. Lorsqu'aucun
Modified: trunk/Scribus/doc/it/menu.xml
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=22948&path=/trunk/Scribus/doc/it/menu.xml
==============================================================================
--- trunk/Scribus/doc/it/menu.xml (original)
+++ trunk/Scribus/doc/it/menu.xml Sat Apr 13 16:30:11 2019
@@ -126,6 +126,7 @@
<submenuitem text="Setting Object Properties" file="scripterapi-setobjprop.html"/>
<submenuitem text="Getting Object Properties" file="scripterapi-getobjprop.html"/>
<submenuitem text="Manipulating Objects" file="scripterapi-manobj.html"/>
+ <submenuitem text="Creating & Manipulating Styles" file="scripterapi-styles.html"/>
<submenuitem text="Handling Text Frames" file="scripterapi-textframes.html"/>
<submenuitem text="Color Commands" file="scripterapi-color.html"/>
<submenuitem text="Font Commands" file="scripterapi-font.html"/>
Modified: trunk/Scribus/doc/it/scripterapi-object.html
URL: http://scribus.net/websvn/diff.php?repname=Scribus&rev=22948&path=/trunk/Scribus/doc/it/scripterapi-object.html
==============================================================================
--- trunk/Scribus/doc/it/scripterapi-object.html (original)
+++ trunk/Scribus/doc/it/scripterapi-object.html Sat Apr 13 16:30:11 2019
@@ -16,118 +16,6 @@
<p>Creates a new bezier curve and returns its name. The points for the bezier curve are stored in the list "list" in the following order: [x1, y1, kx1, ky1, x2, y2, kx2, ky2...xn. yn, kxn. kyn] In the points list, x and y mean the x and y coordinates of the point and kx and ky meaning the control point for the curve. The coordinates are given in the current measurement units of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further access to that object. If "name" is not given Scribus will create one for you.</p>
<p>May raise <a href="scripterapi.html#NameExistsError">NameExistsError</a> if you explicitly pass a name that's already used. May raise ValueError if an insufficient number of points is passed or if the number of values passed don't group into points without leftovers.</p></dd>
-<dt><a name="-createCharStyle"><strong>createCharStyle</strong></a>(...)</dt>
-<dd><code>createCharStyle(...)</code>
-<p>Creates a character style. This function takes the following keyword parameters:
-<ul>
-<li>"name" [required] -> name of the char style to create (first parameter)</li>
-<li>"font" [optional] -> name of the font to use (second parameter)</li>
-<li>fontsize [optional] -> font size to set (double) (third parameter)</li>
-<li>"features" [optional] -> nearer typographic details can be defined by a string that might contain the following phrases comma-separated (without spaces!) (fourth parameter - a string):
-<ul>
- <li>inherit</li>
- <li>bold</li>
- <li>italic</li>
- <li>underline</li>
- <li>underlinewords</li>
- <li>strike</li>
- <li>superscript</li>
- <li>subscript</li>
- <li>outline</li>
- <li>shadowed</li>
- <li>allcaps</li>
- <li>smallcaps</li>
-</ul>
-</li>
-<li>"fillcolor" [optional], fillshade [optional] -> specify fill options (5th parameter: string, 6th parameter: a float 1.0 = 100%)</li>
-<li>"strokecolor" [optional], strokeshade [optional] -> specify stroke options (7th parameter: string, 8th parameter: a float 1.0 = 100%)</li>
-<li>baselineoffset [optional] -> offset of the baseline (ninth parameter)</li>
-<li>shadowxoffset [optional], shadowyoffset [optional] -> offset of the shadow if used (10th and 11th parameters)</li>
-<li>outlinewidth [optional] -> width of the outline if used (12th parameter)</li>
-<li>underlineoffset [optional], underlinewidth [optional] -> underline options if used (13th and 14th parameters)</li>
-<li>strikethruoffset [optional], strikethruwidth [optional] -> strikethru options if used (15th and 16th parameters)</li>
-<li>scaleh [optional], scalev [optional] -> scale of the chars (17th and 18th parameters - float values, 1.0 = 100%)</li>
-<li>tracking [optional] -> tracking of the text (19th parameter - number with odd math, e.g. -50 = -5.0%)</li>
-<li>"language" [optional] -> language code (20th parameter - a string en = English)</li>
-<li>"fontfeatures" [optional] -> a string that contains a comma-separated list of OpenType font features (21th parameter - a string):
-<ul>
- <li>Ligatures:
- <ul>
- <li>-liga: disable common ligatures</li>
- <li>-clig: disable contextual ligatures</li>
- <li>+dlig: enable discretionary ligatures</li>
- <li>+hlig: enable historical ligatures</li>
- </ul>
- </li>
- <li>Script Position:
- <ul>
- <li>+subs: enable subscript</li>
- <li>+sups: enable superscript</li>
- <li>+ordn: enable ordinals</li>
- </ul>
- </li>
- <li>Capitals:
- <ul>
- <li>+smcp: enable small capitals</li>
- <li>+c2sc: enable small capitals from capitals</li>
- <li>+pcap: enable petite capitals</li>
- <li>+c2pc: enable petite capitals from capitals</li>
- <li>+unic: enable unicase</li>
- <li>+titl: enable titling</li>
- </ul>
- </li>
- <li>Numerals:
- <ul>
- <li>+lnum: enable lining figures</li>
- <li>+tnum: enable old style numerals</li>
- </ul>
- </li>
- <li>Numeral Width:
- <ul>
- <li>+pnum: enable proportional figures</li>
- <li>+tnum: enable tabular figures</li>
- </ul>
- </li>
- <li>Numeral Fractions:
- <ul>
- <li>+frac: enable diagonal fractions</li>
- <li>+afrc: enable stacked fractions</li>
- </ul>
- </li>
- <li>Numeral zero:
- <ul>
- <li>+zero: enable slashed zero</li>
- </ul>
- </li>
- <li>Style sets:
- <ul>
- <li>+ss01: enable 1st style set</li>
- <li>...</li>
- <li>+ss20: enable 20th style set</li>
- </ul>
- </li>
-</ul>
-</li>
-</ul>
-</p>
-<p>On a practical level, this is a challenging command to fully understand if you wish to assign a number of settings, since keeping track of where you are, and which kind of entry is needed (string vs number) is not easy. For some guidance on this showing in particular how to set tracking, see the wiki page <a href="https://wiki.scribus.net/canvas/Text_and_Text_Manipulation">Text and Text Manipulation</a>.</p>
-</dd>
-
-<dt><a name="-createCustomLineStyle"><strong>createCustomLineStyle</strong></a>(...)</dt>
-<dd><code>createCustomLineStyle(styleName, style)</code>
-<p>Creates the custom line style 'styleName'.</p>
-<p>This function takes list of dictionary as parameter for "style". Each dictionary represent one subline within style. Dictionary can have those keys:
-<ul>
-<li>Color [optional] -> name of the color to use (string)</li>
-<li>Dash [optional] -> type of line to use (integer)</li>
-<li>LineEnd [optional] -> type of LineEnd to use (integer)</li>
-<li>LineJoin [optional] -> type of LineJoin to use (integer)</li>
-<li>Shade [optional] -> opacity of line (integer)</li>
-<li>Width [optional] -> width of line (double)</li>
-</ul>
-</p>
-</dd>
-
<dt><a name="-createEllipse"><strong>createEllipse</strong></a>(...)</dt>
<dd><code>createEllipse(x, y, width, height, ["name"]) -> string</code>
<p>Creates a new ellipse on the current page and returns its name. The coordinates are given in the current measurement units of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further referencing of that object. If "name" is not given Scribus will create one for you.</p>
@@ -142,43 +30,6 @@
<dd><code>createLine(x1, y1, x2, y2, ["name"]) -> string</code>
<p>Creates a new line from the point(x1, y1) to the point(x2, y2) and returns its name. The coordinates are given in the current measurement unit of the document (see UNIT constants). "name" should be a unique identifier for the object because you need this name for further access to that object. If "name" is not given Scribus will create one for you.</p>
<p>May raise <a href="scripterapi.html#NameExistsError">NameExistsError</a> if you explicitly pass a name that's already used.</p></dd>
-
-<dt><a name="-createParagraphStyle"><strong>createParagraphStyle</strong></a>(...)</dt>
-<dd><code>createParagraphStyle(...)</code>
-<p>Creates a paragraph style. This function takes the following keyword parameters:
-<ul>
-<li>"name" [required] -> specifies the name of the paragraphstyle to create</li>
-<li>linespacingmode [optional] -> specifies the linespacing mode; possible modes are:
-<ul>
- <li>fixed linespacing: 0</li>
- <li>automatic linespacing: 1</li>
- <li>baseline grid linespacing: 2</li>
-</ul>
-</li>
-<li>linespacing [optional] -> specifies the linespacing if using fixed linespacing</li>
-<li>alignment [optional] -> specifies the alignment of the paragraph
-<ul>
- <li>left: 0</li>
- <li>center: 1</li>
- <li>right: 2</li>
- <li>justify: 3</li>
- <li>extend: 4</li>
-</ul>
-</li>
-<li>leftmargin [optional], rightmargin [optional] -> specify the margin</li>
-<li>gapbefore [optional], gapafter [optional] -> specify the gaps to the heading and following paragraphs</li>
-<li>firstindent [optional] -> the indent of the first line</li>
-<li>hasdropcap [optional] -> specifies if there are caps (1 = yes, 0 = no)</li>
-<li>dropcaplines [optional] -> height (in lines) of the caps if used</li>
-<li>dropcapoffset [optional] -> offset of the caps if used</li>
-<li>"charstyle" [optional] -> char style to use</li>
-</ul>
-</p>
-<p>If you wish to skip a number of settings, unfortunately, this command will not accept null values, i.e., a series of commas. You <i>must</i> put some integer value for each of the potential parameters. For example, imagine you wish to only specify a name for the Paragraph Style, and the Character Style. Your command should be something like:</p>
-<p><strong>scribus.createParagraphStyle("MyNewStyle",0,0,0,0,0,0,0,0,0,"MyCharStyle")</strong></p>
-<p>On the other hand, if you only wanted to specify a name and linespacing mode, you can quit whenever after you finished with non-zero data:</p>
-<p><strong>scribus.createParagraphStyle("MyOtherNewStyle",1)</strong></p>
-</dd>
<dt><a name="-createPathText"><strong>createPathText</strong></a>(...)</dt>
<dd><code>createPathText(x, y, "textbox", "beziercurve", ["name"]) -> string</code>
@@ -210,18 +61,6 @@
<dd><code>deleteObject(["name"])</code>
<p>Deletes the item with the name "name". If "name" is not given the currently selected item is deleted.</p></dd>
-<dt><a name="-getAllStyles"><strong>getAllStyles</strong></a>(...)</dt>
-<dd><code>getAllStyles() -> list</code>
-<p>Deprecated, use getParagraphStyles() instead.</p></dd>
-
-<dt><a name="-getCharStyles"><strong>getCharStyles</strong></a>(...)</dt>
-<dd><code>getCharStyles() -> list</code>
-<p>Return a list of the names of all character styles in the current document.</p></dd>
-
-<dt><a name="-getParagraphStyles"><strong>getParagraphStyles</strong></a>(...)</dt>
-<dd><code>getParagraphStyles() -> list</code>
-<p>Return a list of the names of all paragraph styles in the current document.</p></dd>
-
<dt><a name="-objectExists"><strong>objectExists</strong></a>(...)</dt>
<dd><code>objectExists(["name"]) -> bool</code>
<p>Test if an object with specified name really exists in the document. The optional parameter is the object name. When no object name is given, returns True if there is something selected.</p></dd>
More information about the scribus-commit
mailing list