Recent posts

Code / Re: Scribus scripting function...
Last post by Darkoni - November 26, 2023, 08:49:18 PM
And there is another feature in Scribus code:

### 11. LINE_< style >

File: scribus/plugins/scriptplugin/cmdsetprop.h

/*! docstring */
QT_TR_NOOP("setLineStyle(style, [\"name\"])\n\
Sets the line style of the object \"name\" to the style \"style\". If \"name\"\n\
is not given the currently selected item is used.\n\
Argument for this function is number - value from 1 to 37\n\
There are few predefined constants for \"style\" - LINE_< style >.\n\
In Property Palette this feature is selected in box named 'Type of line'\n\
/*! Set line end */
PyObject *scribus_setlinestyle(PyObject * /*self*/, PyObject* args);

Why is this important?

There is a nice site Scribus Scripter API

"This API documentation has been generated from Scribus 1.7.0.svn (2023-11-18)."

And on one of the pages there is missing content.

Missing documentation for setTableStyle and also page footer is missing.

All because of HTML tag style in Scribus code.

All becouse of text LINE_< style > in code.

Could Scribus dev team fix this minor thing?


Darko Nikolić
Code / Scribus scripting functions do...
Last post by Darkoni - November 26, 2023, 06:53:00 PM

When I looked at and analyzed the source code, I noticed that a dozen Scribus scripting functions had poorly formatted descriptions.

If you would be willing to correct them, I am attaching a list of errors and a list of my suggestions on how to correct them.

* currentPage() -> integer
* currentPage() -> integer
* currentPage() -> integer Returns the number of the current working page based on the section of the document.
* getImageColorSpace(["name"]) -> integer Returns the color space for the image loaded in image frame "name" as one of following integer constants: CSPACE_RGB (0), CSPACE_CMYK (1), CSPACE_GRAY (2), CSPACE_DUOTONE (3) or CSPACE_MONOCHROME (4). Returns CSPACE_UNDEFINED (-1) if no image is loaded in the frame. If "name" is not given the currently selected item is used.
* getLineCap(["name"]) -> integer (see constants)
* getLineJoin(["name"]) -> integer (see constants)
* getLineStyle(["name"]) -> integer (see constants)
* getObjectAttributes(["name"]) -> list Returns a list containing all attributes of object "name".
* getUnit() -> integer (Scribus unit constant)
* Obsolete function. Don't use it.
* setitemname(newName, ["name"])
* setitemname(newName, ["name"])
* Scribus internal.
* Scribus internal.

### 01. currentPage()

File: scribus/plugins/scriptplugin/scriptplugin.cpp

Set function name to currentPageNumberForSection() and remove spaces in front of lines

/*! docstring */
QT_TR_NOOP("currentPageNumberForSection() -> integer\n\
Returns the number of the current working page based on the section of the document.\n\
/*! get actual page */
PyObject *scribus_currentpagenumberforsection(PyObject * /*self*/);

I see that currentPage and currentPageNumber calls the scribus_currentpage function.

But, when people are creating documentation from Scribus source, then they will get [/b]currentPage[/b] twice.

Like here:

That can be fixed by adding

/*! docstring */
QT_TR_NOOP("currentPageNumber() -> integer\n\
Returns the number of the current working page. Page numbers are counted from 1\n\
upwards, no matter what the displayed first page number of your document is.\n\
/*! get actual page */
PyObject *scribus_currentpage(PyObject * /*self*/);

And changing line

{const_cast<char*>("currentPageNumber"), (PyCFunction)scribus_currentpage, METH_NOARGS, tr(scribus_currentpagenumber__doc__)},

### 02. getImageColorSpace(["name"]) -> integer

File: scribus/plugins/scriptplugin/cmdgetprop.h

/*! docstring */
QT_TR_NOOP("getImageColorSpace([\"name\"]) -> integer\n\
Returns the color space for the image loaded in image frame \"name\" as one of following integer constants:\n\
CSPACE_UNDEFINED (-1) if no image is loaded in the frame.\n\
If \"name\" is not given the currently selected item is used.\n\
PyObject *scribus_getimagecolorspace(PyObject * /*self*/, PyObject* args);

### 03. getLineCap(["name"]) -> integer

File: scribus/plugins/scriptplugin/cmdgetprop.h

/*! docstring */
QT_TR_NOOP("getLineCap([\"name\"]) -> integer\n\
Returns the line cap style of the object \"name\".\n\
If \"name\" is not given the currently selected item is used.\n\
The cap types are:\n\
/*! Returns cap type of the line */
PyObject *scribus_getlinecap(PyObject * /*self*/, PyObject* args);

### 04. getLineJoin(["name"]) -> integer

File: scribus/plugins/scriptplugin/cmdgetprop.h

/*! docstring */
QT_TR_NOOP("getLineJoin([\"name\"]) -> integer\n\
Returns the line join style of the object \"name\".\n\
If \"name\" is not given the currently selected item is used.\n\
The join types are:\n\
/*! Returns join type of the line */
PyObject *scribus_getlinejoin(PyObject * /*self*/, PyObject* args);

### 05. getLineStyle(["name"]) -> integer (see constants)

File: scribus/plugins/scriptplugin/cmdgetprop.h

/*! docstring */
QT_TR_NOOP("getLineStyle([\"name\"]) -> integer\n\
Returns the line style of the object \"name\".\n\
If \"name\" is not given the currently selected item is used.\n\
Line style constants are:\n\
/*! Returns style type of the line */
PyObject *scribus_getlinestyle(PyObject * /*self*/, PyObject* args);

### 06. getObjectAttributes(["name"]) -> list

File: scribus/plugins/scriptplugin/cmdgetprop.h

/*! docstring */
QT_TR_NOOP("getObjectAttributes([\"name\"]) -> list\n\
Returns a list containing all attributes of object \"name\".\n\
PyObject *scribus_getobjectattributes(PyObject * /*self*/, PyObject* args);

### 07. getUnit() -> integer

File: scribus/plugins/scriptplugin/cmddoc.h

/*! docstring */
QT_TR_NOOP("getUnit() -> integer\n\
Returns the measurement units of the document.\n\
The returned value will be one of the UNIT_* constants:\n\
/** Returns actual unit scale. */
PyObject *scribus_getunit(PyObject * /*self*/);

### 08. Obsolete function. Don't use it.

File: scribus/plugins/scriptplugin/scriptplugin.cpp

Please, comment line as it is obsolete.

// {const_cast<char*>("pageDimension"), (PyCFunction)scribus_getpagesize, METH_NOARGS, "Obsolete function. Don't use it."},

### 09. setitemname

The better name for function is setItemName

File: scribus/plugins/scriptplugin/cmdsetprop.h

/*! docstring */
QT_TR_NOOP("setItemName(newName, [\"name\"])\n\
Sets the name of object \"name\" to newName and returns the name applied.\n\
If \"name\" is not given the currently selected item is used.\n\
May raise NotFoundError if the object doesn't exist.\n\
/*! Set newname */
PyObject *scribus_setitemname(PyObject * /*self*/, PyObject* args);

Comment line to remove call to function [/b]setNewName[/b]

File: scribus/plugins/scriptplugin/scriptplugin.cpp
// {const_cast<char*>("setNewName"), scribus_setitemname, METH_VARARGS, tr(scribus_setitemname__doc__)}, // Deprecated, was in fact never documented

### 10. Scribus internal.

File: scribus/plugins/scriptplugin/scriptplugin.cpp

Please, change

// {const_cast<char*>("retval"), (PyCFunction)scribus_retval, METH_VARARGS, const_cast<char*>("Scribus internal.")},
// {const_cast<char*>("getval"), (PyCFunction)scribus_getval, METH_NOARGS, const_cast<char*>("Scribus internal.")},
{const_cast<char*>("retval"), (PyCFunction)scribus_retval, METH_VARARGS, tr(scribus_retval__doc__)},
{const_cast<char*>("getval"), (PyCFunction)scribus_getval, METH_NOARGS,  tr(scribus_getval__doc__)},

And add to file scribus/plugins/scriptplugin/cmdsetprop.h

/*! docstring */
Scribus internal.\n\


/*! docstring */
Scribus internal.\n\


Darko Nikolić
Scripts and Plugins / Re: Scribus 1.7.0.svn New Scri...
Last post by a.l.e - November 26, 2023, 11:09:31 AM
hi darko


some feedback from my side:

  • guidesLock() and guidesSnap(): they need an argument -- defaulting to True -- for turning off the feature. probably the companions isGuidesLock() and isGuidesSnap() are also to be created in the same go (this is mostly an instinctive reaction: i'm not 100% sure that there is a use case for checking the state)
    finally, the commands should probably go to cmdpage, not cmdtext.
  • textFrameChainShow(): i'd rather call it showTextFramesChain() and as for the guides, it should have an argument to turn it off and a "getter" to test its state.
  • unlinkTextFrameAndCutText(): rather than creating a new function, i'd prefer to see a new named (optional) argument (cutText=False) in unlinkTextFrame().
  • selectObjectAlone(): it's indeed tedious to always need to clear the selection first. as for unlinking the text frames, i'd prefer a named argument "clearSelection=False" in selectObject, which would also "automatically" better document the "odd" behavior of selectObject()
  • placeSVGname(): i'd prefer to see placeSVG() to always return the name of the group that has been created (iirc, not trivial to do; but i think that i have an unfinished patch that goes in that direction)
  • placeSVGnameFromString(): i guess that the filename in placeSVG() should be optional and it needs a named argument svgString (or similar). probably, you saw that coming, after the previous comments : - )
  • insterHTMLFromString(): see above : - )
  • getDocumentation: you can achieve the same with python's dir (and with the inspect module it gets rather powerful: i have a script -- currently in a ḧeavy refactoring process (adding arbitrary text) -- that with the help of mkdocs produces ).
    i'm not sure that this new command is really needed.

all in all, you seem to propose a few useful commands for the scripter api and a few others that can help in automatically setting up a "standard" environment.


if you need help for the changes i suggested just ask.
it would be nice if you could propose patches that can get into scribus!

have a nice sunday
MacOS / Problems booting scribus 1.4.8...
Last post by André - November 25, 2023, 11:30:41 PM

I'm from Austria, so pls. excuse my English.

I installed Scribus 1.4.8 on a mini some time ago, used it a bit, but not much. I switched to a Mac mini intel 3,2GHz i7 using the  OS migration tool, all programs worked fine. But for Scribus. When I start Scribus now, it takes over ten minutes to boot and does not respond to inpute.
I thought, OK, I should be able to run Scribus 1.5.8, but OS refuses to boot it, saying I should be 10.15, not 10.14
Deleted the folder, downloaded 1.4.8 from the website, reinstalled it - same effect.

When it boots up, it seems normal speed until it comes to "loading color profiles". I have no color profiles installd, to my knowledge

Does anybody know what went wrong and help me pls?
Scripts and Plugins / Scribus 1.7.0.svn New Scriptin...
Last post by Darkoni - November 25, 2023, 10:04:43 PM

I have made a compilation of my own script functions that I needed for Scribus.

The functions are:

* guidesLock
* guidesSnap
* textFrameChainShow
* unlinkTextFrameAndCutText
* selectObjectAlone
* placeSVGname
* placeSVGnameFromString
* insertHtmlFromString
* getDocumentationIndex
* getDocumentation

More on GitLab:

Darko Nikolić  8)
Beginner Talk / Re: Image frames with borders ...
Last post by AdmFubar - November 25, 2023, 06:37:30 PM
A quick and dirty solution for this is to add a border/frame/stroke to the image and make it transparent. You will loose a few pixels of the image from how scribus adds border to an image but this might be acceptable.
Beginner Talk / Re: Image frames with borders ...
Last post by Erik96 - November 25, 2023, 10:32:33 AM
Hello utnik,
thx a lot, great. It works perfectly.
Have a great day
Beginner Talk / Re: Image frames with borders ...
Last post by utnik - November 25, 2023, 07:49:12 AM
hi erik

go to 'properties' (f2)→ 'shape' → 'text flow'. select 'text flow around contour line'. then click on 'edit' and check the box 'edit contour line'. now you may either insert a value to increase the size of the contour line on all sides or select the control points direct on your document page (usually in pairs) and move them with the arrow keys (maybe with 'shift' or 'ctrl' as modifiers) or move them manually or select one point at a time and modify the x and y coordinates in the nodes editor...

Beginner Talk / Re: Image frames with borders ...
Last post by PatJr - November 25, 2023, 01:56:35 AM
Did you try the Properties (F2) under shape and select the 2nd option for the Text flow? You also edit the image frame boundary box.
Or try the Content Properties (F3) and then fiddle with the image scale, position, and frame size to get a padding that works. Is that what you are looking for?
Beginner Talk / Image frames with borders and ...
Last post by Erik96 - November 24, 2023, 11:43:58 PM
Dear All,
I searched in the issues of this forum, but I did not find anything similar, so I ask this question, even if I am convinced that others might have had the same doubts in the past.
I would like to include in my text images. I have seen that when I create an image frame I can specify that the text flows around the image. But, I do not succeed in leaving a little white space between the image and the text, call it border or whatsoever. I tried with embedding the image frame in a textframe, this work, but I do not know if this is the ideal way of working. I would also need to put captions under the image to describe them (kind: Fig 1: Example of Config File). Yes, I could add under the image frame a text frame and embed the both in the textframe I mentioned before. Again, is this the recommended way of working ?
Thank you very much
Yours, sincerely