add_feature_info("Safe Asserts" HIDE_SAFE_ASSERTS "Don't show message box for \"safe\" asserts, just ignore them automatically and dump a message to the terminal.")
option(FOUNDATION_BUILD "A Foundation build is a binary release build that can package some extra things like color themes. Linux distributions that build and install Krita into a default system location should not define this option to true." OFF)
add_feature_info("Foundation Build" FOUNDATION_BUILD "A Foundation build is a binary release build that can package some extra things like color themes. Linux distributions that build and install Krita into a default system location should not define this option to true.")
option(KRITA_ENABLE_BROKEN_TESTS "Enable tests that are marked as broken" OFF)
add_feature_info("Enable Broken Tests" KRITA_ENABLE_BROKEN_TESTS "Runs broken test when \"make test\" is invoked (use -DKRITA_ENABLE_BROKEN_TESTS=ON to enable).")
# KConfig deprecated authorizeKAction. In order to be warning free,
# compile with the updated function when the dependency is new enough.
# Remove this (and the uses of the define) when the minimum KF5
# version is >= 5.24.0.
if (${KF5Config_VERSION} VERSION_LESS "5.24.0" )
message("Old KConfig (< 5.24.0) found.")
add_definitions(-DKCONFIG_BEFORE_5_24)
endif()
find_package(Qt5 ${MIN_QT_VERSION}
REQUIRED COMPONENTS
Core
Gui
Widgets
Xml
Network
PrintSupport
Svg
Test
Concurrent
)
include (MacroAddFileDependencies)
include (MacroBoolTo01)
include (MacroEnsureOutOfSourceBuild)
macro_ensure_out_of_source_build("Compiling Krita inside the source directory is not possible. Please refer to the build instruction https://community.kde.org/Krita#Build_Instructions")
# Note: OPTIONAL_COMPONENTS does not seem to be reliable
# (as of ECM 5.15.0, CMake 3.2)
find_package(Qt5Multimedia ${MIN_QT_VERSION})
set_package_properties(Qt5Multimedia PROPERTIES
DESCRIPTION "Qt multimedia integration"
URL "http://www.qt.io/"
TYPE OPTIONAL
PURPOSE "Optionally used to provide sound support for animations")
if (choiceType->propertyType() == TypeInfo::IntegerType) {
var = var.toInt();
} else if (choiceType->propertyType() == TypeInfo::DateType) { // TODO QVariant date parser isn't very good with XMP date (it doesn't support YYYY and YYYY-MM
KisAsyncActionFeedback f(i18nc("progress dialog message when the user closes the document that is being saved", "Waiting for saving to complete..."), 0);
if (!tabBar && d->mdiArea->viewMode() == QMdiArea::TabbedView) {
qWarning() << "WARNING!!! Cannot find QTabBar in the main window! Looks like Qt has changed behavior. Drag & Drop between multiple tabs might not work properly (tabs will not switch automatically)!";
// dbgFile << "profile name: " << profile->productName() << " profile description: " << profile->productDescription() << " information sur le produit: " << profile->productInfo();
if (!profile->isSuitableForOutput()) {
dbgFile << "the profile is not suitable for output and therefore cannot be used in krita, we need to convert the image to a standard profile"; // TODO: in ko2 popup a selection menu to inform the user
}
}
}
else {
dbgFile << "no embedded profile, will use the default profile";
//TODO: two fixes : one tell the user about the problem and ask for a solution, and two once the kocolorspace include KoColorTransformation, use that instead of hacking a lcms transformation
m_image->setResolution((double) POINT_TO_CM(x_resolution) / 100.0, (double) POINT_TO_CM(y_resolution) / 100.0); // It is the "invert" macro because we convert from pointer-per-inchs to points
int color_nb_bits = 8 * device->pixelSize() / device->channelCount();
int color_type = getColorTypeforColorSpace(device->colorSpace(), options.alpha);
Q_ASSERT(color_type > -1);
// Try to compute a table of color if the colorspace is RGB8f
png_colorp palette = 0;
int num_palette = 0;
if (!options.alpha && options.tryToSaveAsIndexed && KoID(device->colorSpace()->id()) == KoID("RGBA")) { // png doesn't handle indexed images and alpha, and only have indexed for RGB8
palette = new png_color[255];
KisSequentialIterator it(device, imageRect);
bool toomuchcolor = false;
while (it.nextPixel()) {
const quint8* c = it.oldRawData();
bool findit = false;
for (int i = 0; i < num_palette; i++) {
if (palette[i].red == c[2] &&
palette[i].green == c[1] &&
palette[i].blue == c[0]) {
findit = true;
break;
}
}
if (!findit) {
if (num_palette == 255) {
toomuchcolor = true;
break;
}
palette[num_palette].red = c[2];
palette[num_palette].green = c[1];
palette[num_palette].blue = c[0];
num_palette++;
}
}
if (!toomuchcolor) {
dbgFile << "Found a palette of " << num_palette << " colors";
color_type = PNG_COLOR_TYPE_PALETTE;
if (num_palette <= 2) {
color_nb_bits = 1;
} else if (num_palette <= 4) {
color_nb_bits = 2;
} else if (num_palette <= 16) {
color_nb_bits = 4;
} else {
color_nb_bits = 8;
}
} else {
delete [] palette;
}
}
int interlacetype = options.interlace ? PNG_INTERLACE_ADAM7 : PNG_INTERLACE_NONE;
png_set_pHYs(png_ptr, info_ptr, CM_TO_POINT(xRes) * 100.0, CM_TO_POINT(yRes) * 100.0, PNG_RESOLUTION_METER); // It is the "invert" macro because we convert from pointer-per-inchs to points
int columns = fixEndianess<quint16>((reinterpret_cast<quint16*>(array.data()))[0], order);
int rows = fixEndianess<quint16>((reinterpret_cast<quint16*>(array.data()))[1], order);
if ((columns * rows + 4) > dvalue->count()) { // Sometime byteOrder get messed up (especially if metadata got saved with kexiv2 library, or any library that doesn't save back with the same byte order as the camera)
int columns = fixEndianess<quint16>((reinterpret_cast<quint16*>(array.data()))[0], order);
int rows = fixEndianess<quint16>((reinterpret_cast<quint16*>(array.data()))[1], order);
if ((columns * rows + 4) != dvalue->count()) { // Sometime byteOrder get messed up (especially if metadata got saved with kexiv2 library, or any library that doesn't save back with the same byte order as the camera)
if ((key.groupName() == "exif" || key.groupName() == "tiff") && key.tagName() == "NativeDigest") { // TODO: someone who has time to lose can look in adding support for NativeDigest, it's undocumented use by the XMP SDK to check if exif data has been changed while XMP hasn't been updated
- feedback = i18n("Couldn't add bundle to resource server");
- bundleFeedback.setText(feedback);
- bundleFeedback.exec();
- }
- if(!bundleServer->removeFromBlacklist(bundle)){
- feedback = i18n("Couldn't remove bundle from blacklist");
- bundleFeedback.setText(feedback);
- bundleFeedback.exec();
- }
+ bool isKrita3Bundle = false;
+ if (bundle->filename().contains("Krita_3_Default_Resources.bundle")) {
+ isKrita3Bundle = true;
+ KConfigGroup group = KSharedConfig::openConfig()->group("BundleHack");
+ group.writeEntry("HideKrita3Bundle", false);
}
else {
- bundleServer->removeFromBlacklist(bundle);
- //let's assume that bundles that exist and are installed have to be removed from the blacklist, and if they were already this returns false, so that's not a problem.
+ if (!bundle->isInstalled()) {
+ bundle->install();
+ //this removes the bundle from the blacklist and add it to the server without saving or putting it in front//
+ if (!bundleServer->addResource(bundle, false, false)){
+
+ feedback = i18n("Couldn't add bundle to resource server");
+ bundleFeedback.setText(feedback);
+ bundleFeedback.exec();
+ }
+ if (!isKrita3Bundle) {
+ if (!bundleServer->removeFromBlacklist(bundle)) {
+ feedback = i18n("Couldn't remove bundle from blacklist");
+ bundleFeedback.setText(feedback);
+ bundleFeedback.exec();
+ }
+ }
+ }
+ else {
+ if (!isKrita3Bundle) {
+ bundleServer->removeFromBlacklist(bundle);
+ }
+ //let's assume that bundles that exist and are installed have to be removed from the blacklist, and if they were already this returns false, so that's not a problem.
<p>This is the Comics Project Management Tools python plugin for Krita.</p>
<p>CPMT aims to simplify comics creation by:</p>
<ul>
<li>Giving the artist a way to organize and quickly access their pages.</li>
<li>Helping the artist(s) deal with the boring bits meta data bits of a comic project by giving a meta-data editor that gives suggestions, explanation and occasionally a dab of humor.</li>
<li>Making export set-and-forget type of affair where a single click can export to multiple formats with proper meta-data.</li>
</ul>
<p>Export-wise, CPMT aims to support:</p>
<dl>
<dt>Advanced Comic Book Format</dt>
<dd>An open comics format that has detailed markup as well as support for translations.
</dd>
<dt>CBZ</dt>
<dd>the most popular comic file format, with the following meta-data schemes:
<ul>
<li>ACBF - as above.</li>
<li>CoMet.xml</li>
<li>ComicBookInfo (Spec is unclear so not 100% certain)</li>
<li> ComicInfo.xml(Comic Rack)</li>
</ul>
</dd>
<dt>Epub</dt>
<dd>The epub publishing format. Not the most ideal format for handling comics, but most readers can open epub.
-<p>First, get the comic manager docker(settings → dockers → comic Management Docker). There, select <em>New Project</em>.</p>
+<p>First, get the comic manager docker(settings → dockers → comic Management Docker). There, select <em>New Project</em>.</p>
<p>It will show a dialog asking for:</p>
<dl>
<dt>The project directory.</dt>
<dd>This is where everything will be written to.
</dd>
<dt>Concept</dt>
<dd>so a simple sentence explaining what you want to write the comic about. This concept is just for you.
</dd>
<dt>Project name.</dt>
<dd>This is not the title, but more of a code name which will be used to create pages. For the impatient artist there is even a generator that produces code names.
</dd>
<dt>Language</dt>
<dd>The main language, used for all the meta data. By default set to the system locale.
</dd>
<dt>Make a new directory with the project name.</dt>
<dd>Whether to make a new project directory inside the selected directory. This allows you to have a generic comics directory that you always select and that CPMT will make directories named with the project name inside.
</dd>
<dt>Pages</dt>
<dd>The name for the directory to store the pages. This is where new pages are placed.
</dd>
<dt>Export</dt>
<dd>The name for the directory to store the export. This is where the comic will be exported to.
</dd>
<dt>Templates</dt>
<dd>The name for the directory to store the template. This is where the page templates get stored.
</dd>
+<dt>Translations</dt>
+<dd>The translations directory is where the POT file will be stored and where the exporter searches for translation(PO) files.</dd>
</dl>
<p>It will also allow you to edit meta data if you'd want already, but this is not mandatory.</p>
-<p>Then after you finish, select <em>Open Project</em>, go to the location where you have stored your comics project. There should be a “comicsConfig.json” file there, next to the new folders for the pages, templates and export. Open that.</p>
+<p>Then after you finish, select <em>Open Project</em>, go to the location where you have stored your comics project. There should be a “comicsConfig.json” file there, next to the new folders for the pages, templates and export. Open that.</p>
<p>Now, click <em>Add Page</em> to add your first page. You will get a dialog asking for the template. Here you can generate one, or import one. CPMT will remember this as the default one.</p>
<p>Double click the new page to open in Krita.</p>
-<p>The second column in the docker allows you to see the “subject” line in the document info if it's filled in.</p>
+<p>The second column in the docker allows you to see the “subject” line in the document info if it's filled in.</p>
<p>You can press the arrow next to <em>Add Page</em> to get more features, like <em>Add Existing Page</em>, <em>Remove Page</em>, or <em>Batch Resize</em>.</p>
<h2 id="usage---meta-data">Usage - Meta Data</h2>
<p>You can edit the meta data by clicking the dropdown next to <em>Project Settings</em> and selecting <em>Meta Data</em>.</p>
<p>There's quite a few fields here, because there's quite a few different types of meta data. Hover over the fields to get an idea of what needs to be typed.</p>
<p>The meta data is intended to be filled out over the course of the project, so don't worry too much if you cannot instantly think of what a certain entry should be.</p>
<p>The meta data fields have auto completion wherever sensible. You can add your own meta data fields as noted in the following section:</p>
<h3 id="adding-extra-auto-completion-keys.">Adding extra auto-completion keys.</h3>
<p>First, you need to go to project settings, and there point the extra keys to a folder where extra keys can be found.</p>
<p>It will search that extra folder for the following folders:</p>
<ul>
<li>key_genre</li>
<li>key_format</li>
<li>key_rating</li>
<li>key_characters</li>
<li>key_author_roles</li>
<li>key_other</li>
</ul>
-<p>You can add extra auto-completion keys by adding a text file with each new key on a separate line to one of the “key” folders. The name of the text file doesn't matter. This way you can add characters by universe, or archive specific keywords by archive name.</p>
+<p>You can add extra auto-completion keys by adding a text file with each new key on a separate line to one of the “key” folders. The name of the text file doesn't matter. This way you can add characters by universe, or archive specific keywords by archive name.</p>
<p>So for example, the following file has three superhero names on different lines, nothing more, nothing less.</p>
<pre><code> Spider-Man
Hawkeye
Jean Grey</code></pre>
-<p>When you then store it as marvel.txt put into the directory “key_characters”, Krita will use the names from the list as suggestion for the character field in the meta-data.</p>
+<p>When you then store it as marvel.txt put into the directory “key_characters”, Krita will use the names from the list as suggestion for the character field in the meta-data.</p>
<p>The exception is the key_ratings, which uses CSV files, using the top row to determine the title, and then has the rating in the first column, and the description on the second. This allows the description to show up as tool-tips.</p>
<h3 id="the-author-list">The Author list</h3>
<p>The author list is a table containing all the authors of the project. It allows a distinction between given, family, middle and nickname, as well as role, email and homepage.</p>
<p>You can rearrange the author list by drag and dropping the number at the left, as well as adding and removing authors.</p>
-<p>Adding an author will always add “John Doe”. You can double click the names and cells to change their contents. For the role, there are auto completion keys, so to encourage using standardized ways to describe their roles.</p>
+<p>Adding an author will always add “John Doe”. You can double click the names and cells to change their contents. For the role, there are auto completion keys, so to encourage using standardized ways to describe their roles.</p>
<p>In the main docker, there's an option under the pages actions called <em>Scrape Authors</em>, this will make the comics project docker search the pages in the pages list for author info and append that to the author list. It will not attempt to check for duplicates, so be sure to the list afterwards.</p>
<p>The project settings allows you to change all the technical details of the project:</p>
<ul>
<li>the project name</li>
<li>the concept</li>
<li>the location of pages, export and templates</li>
<li>the default template.</li>
<li>the location of the extra auto-completion keys(see metadata)</li>
</ul>
<h2 id="usage---pages">Usage - Pages</h2>
<p>There's several other things you can do with pages. You can either access these feature by clicking the drop-down next to <em>Add Page</em> or right-clicking the pages list.</p>
-<dl>
<dt>Adding pages</dt>
<dd>You can add pages by pressing the <em>Add Page</em> button. The first time you press this, it'll ask for a template. After you create or select a template it will use this as the default. You can set the default in the project settings.
</dd>
<dt>Adding pages from template:</dt>
<dd>Adding pages from a template will always give the template dialog. This will allow you to have several different templates in the templates directory(it will show all the kra files in the templates directory), so that you can have spread, coverpages and other pages at your finger tips. The create template dialog will allow you to make a simple two layer image with a white background, and rulers for the bleeds and guides. Import template will copy selected templates to the template directory, keeping all the necessary files inside the comics project.
</dd>
<dt>Remove a page</dt>
<dd>This allows you to remove the selected page in the list from the pages list. It does NOT delete the page from the disk.
</dd>
<dt>Adding existing pages</dt>
<dd>This is for when you wish to add existing pages, either because you removed the page from the list, or because you already have a project going and wish to add the pages to the list.
</dd>
<dt>Batch Resize</dt>
<dd>This will show a window with resize options. After selecting the right options, all the pages will be resized as such. A progress dialog will pop up showing you which pages have been done and how long it will take based on the passed time.
</dd>
<dt>View Page in Window</dt>
-<dd>This will pop up a dialog with the selected page's mergedimage.png. The dialog will update when doing this for the image of another page. This is so that you can have a quick reference for a single page in the event your other referencing tools cannot open kra files.
-</dd>
+<dd>This will call up the comic viewer.</dd>
<dt>Scrape Authors</dt>
-<dd>This searches all the files from the pages list for author information and adds that to the author list. It will not check for copies, so you will need to clean up the author list yourself.
-</dd>
+<dd>This searches all the files from the pages list for author information and adds that to the author list. It will not check for copies, so you will need to clean up the author list yourself.</dd>
+<dt>Scrape Text for Translations</dt>
+<dd>This triggers a script that will go over each page and take out certain text information it can find. It will use the 'text layer keys' in the export dialog to determine whether a vector layer's text ought to be considered. Then, when done, it will put the text it found into a POT file, together with translatable meta-data, like the comic title, and will save it in the translations folder. The POT file can then be used by translators(using something like PO edit) to create a PO file. The CPMT can in turn use the PO files in the creation of ACBF files which'll embed the translations.</dd>
<dt>Rearranging pages</dt>
<dd>You can rearrange pages by moving the number on the left of the page up or down.
</dd>
+<h3 id="comicviewer">The Comic Viewer</h3>
+<p>When you rightclick the pages, or press the down button next to <span style="font-style: italic;">Add Page</span>, There's the option <span style="font-style: italic;">View page in window.</span>This will pop up a comic viewer, which is each page's mergedimage.png file(that is a preview of all visible layers merged), and you can flip through them. This is so that you can have a quick reference for a single page in the event your other referencing tools cannot open kra files.</p>
+<dl>
+<dt>First, Last</dt>
+<dd>These will set the viewer to the last or first page in the comic. The hotkeys for these are <kbd>Home</kbd> and <kbd>End</kbd> respectively. These buttons will switch position based on the reading direction configured for the comic.</dd>
+<dt>Previous, Next</dt>
+<dd>These buttons allow you to switch spaces. The hotkeys for these are <kbd>←</kbd> and <kbd>→</kbd> respectively. You can also use <kbd>Space</kbd> to switch to the next page. These buttons will switch position based on the reading direction configured for the comic.</dd>
+<dt>Spread, single</dt>
+<dd>This button will allow you to switch to single or spread mode.</dd>
</dl>
+<p>You can also run the comic viewer standalone:</p>
<p>Copy location, the button underneath the export button, allows you to copy the current project location to clipboard. Just press it, and paste somewhere else. This is useful when using multiple programs and reference tools and you just want to quickly navigate to the project directory.</p>
<h2 id="usage---export">Usage - Export</h2>
<p>CPMT will not allow export without any export methods set.</p>
<p>You can configure the export settings by going to the drop-down next to <em>Project Settings</em> and selecting <em>Export Settings</em>.</p>
<p>Here you can define...</p>
<ul>
<li>how much a page needs to be cropped</li>
<li>which layers to remove by layer color-label</li>
<li>to which formats to export, in what file-format and how to resize.</li>
</ul>
<p>Once you've done that, press export. Krita will pop up a progress bar for you with the estimated time and progress, so you can estimate how long you will have to wait.</p>
<p>CPMT will store the resized files and meta data in separate folders in the export folder. This is so that you can perform optimization methods afterwards and update everything quickly.</p>
<h3 id="acbf">ACBF</h3>
<p>ACBF is the advanced comic book format. It is a metadata file that can hold extra data like panels and text, and can even store translations for the text.</p>
-<p>Krita has some support for frames and text. If you name a vector layer “text” or “panels” it will search those for shapes. The shapes that are text nodes will be added to the ACBF file as a text in the main language of the comic, using the bounding box of the text-shape. The shapes that aren't text will have their bounding boxes used as frames. The order of frames and text is determined by the shape z-order in Krita, with the bottom shape being the first and the top shape being the last.</p>
<p>When you generate a CBZ file, the ACBF file will be generated alongside of it. There's in fact two ACBF files being generated: The one in the metadata folder is the ACBF file as it is inside the CBZ. The other ACBF file, next to the CBZ is the standalonefile. This file has the pages embedded, but there's currently fewer viewers who can read it.</p>
-<p>To fine tune the export to ACBF, you can go to file→document Information and add the following keywords:</p>
+<p>ACBF has a set amount of genres it can cover. This is the default list of genre auto completion keys. Genres outside that will be put into the extra keywords list for ACBF. On top of that, it does allow defining a match to this genre. To set a match to a genre, write a number in brackets indicating how much it matches this genre. So for example “Horror(60), Science Fiction(40)”will have Horror set to 60% and Science Fiction set to 40%. These values are normalized. So if you put in “Romance(550), Fantasy(650)”it will ensure that the two values will become percentages, leading to Romance being set to 46% and Fantasy set to 54%.</p>
+<p>The CPMT has some support for frames and text export. If you name a vector layer “text” or “panels” it will search those for shapes. The shapes that are text nodes will be added to the ACBF file as a text in the main language of the comic, using the bounding box of the text-shape. The shapes that aren't text will have their bounding boxes used as frames. The order of frames and text is determined by the shape z-order in Krita, with the bottom shape being the first and the top shape being the last. You can customize these layer selection keys in the export settings dialog.</p>
+<p>The CPMT also support translations. ACBF will use the PO files stored in the translations folder. In the export dialog, you can configure whether you want translation comments to be embeded. Then, if there's translation comments in the PO file, ACBF will put those in the reference section and add a link to the line with the translation comment. Translations will have translator note headers. You can configure these in the export, and they will also be put into the POT file when it is generated so they may be translated.</p>
+<p>Finally, there's the styles and the text type. You can configure the styles in the export settings dialog tab for acbf. The exporter will use the configuration and alignment to automatically figure out the text-type in the export.</p>
+<ul>
+<li>Text that is justified will use the “formal”type. There's no method to currently make justified text, so this won't trigger until then</li>
+<li>Text that is centered will have it's font family compared to the existing styles and their font-families. If it finds a match that will be the type</li>
+<li>Text that is neither will be marked with “commentary”, that is, it is considered a narrative caption.</li>
+</ul>
+<p>To fine tune the export to ACBF, you can go to file→document Information and add the following keywords:</p>
<dl>
<dt>acbf_title</dt>
-<dd>this will flag this page to be used as a table of contents bookmark inside ACBF. The content mark will use the “title” value in the document information to create a bookmark in the project language.
+<dd>this will flag this page to be used as a table of contents bookmark inside ACBF. The content mark will use the “title” value in the document information to create a bookmark in the project language.
</dd>
<dt>acbf_none</dt>
-<dd>Sets the page transition value to “none” explicitly.
+<dd>Sets the page transition value to “none” explicitly.
</dd>
<dt>acbf_fade</dt>
<dd>Sets the page transitio to fade. Viewers that support it will fade to black into this page.
</dd>
<dt>acbf_blend</dt>
<dd>Sets the page transition to blend. Viewers that support it will fade the previous page to this one.
</dd>
<dt>acbf_horizontal</dt>
<dd>Sets the page transition to scroll_right. Viewers that support it will scroll right to a new page.
</dd>
<dt>acbf_vertical</dt>
<dd>Sets the page transition to scroll_down. Viewers that support it will scroll down to a new page.
</dd>
</dl>
-<h1 id="todo">TODO:</h1>
-<p>Things I still want to do:</p>
-<ul>
-<li>Krita:
-<ul>
-<li>Generate text from the author list. (Requires text api)</li>
-</ul></li>
-<li>clean up path relativeness. (Not sure how much better this can be done)</li>
-<li>Make label removal just a list? (unsure)</li>
-<li>PNG and JPEG export settings.</li>
-</ul>
-<p>ACBF list:</p>
-<ul>
-<li>support getting text info from the vector layers. [Partially done]
-<ul>
-<li>users can specify a name for text layers. (Waiting for stringfreeze to end)</li>
-<li>Don't forget text-rotation(Needs API)</li>
-<li>last two/five characters are used to determine language. (Maybe not a good idea...)</li>
-<li>maybe text-class can be used to determine type? (We'll proly need to use style sheets and comparing the text format to those)
-<ul>
-<li>Speech (speech, dialogue)</li>
-<li>Commentary (caption in american comics)</li>
-<li>Formal (For justified aligned text, like big chunks of text.)</li>
-<li>Letter (Like a letter in a comic)</li>
-<li>Code (Monospaced font)</li>
-<li>Heading (Chapter title)</li>
-<li>Audio (Only meant for audio devices)</li>
-<li>Thought (Thought bubbles and the like)</li>
-<li>Sign (For signs on buildings and the like.)</li>
-<li>Inverted (Whether or not this should be treated as inverted text)</li>
-<li>transparent(For a transparent wordballoon.)</li>
-<li>Question: Where is general sound effects? Like, if we make a distinction between speech and thought, why are general sound effects missing? (Admittedly, I'd prefer if we could allow putting sound effects and such as a base64 reffed bit.) (See 1.2 support)</li>
-</ul></li>
-<li>Get page background color from the page if possible. (This might only work with canvas color, though)</li>
-</ul></li>
-<li>1.2 support:
-<ul>
-<li>Role: designer</li>
-<li>Book-info: reading direction</li>
-<li>text type: Sound.</li>
-</ul></li>
-</ul>
+<h2>Version History</h2>
+<p>Because the comic project management tools are bundled with Krita you could argue that you can identify them that way, but here is a history anyway, so you can check what has changed.</p>
+<dl>
+<dt>Version 2</dt>
+<dd>90% ACBF support, with improved handling of text, translation support, new keys for genres and author roles, style sheets, text-type recognition, database ref, and background color support. The Comic Page viewer has been fully rewritten to handle flipping through the pages as well as made possible to be run standalone.</dd>
+<dt>Version 1 (Krita 4.0)</dt>
+<dd>The initial tools, with project management, page management, meta data management complete with autocompletion keys, copy-location, export to epub, tiff, cbz, and export to zipfile info, ComicInfo.xml and CoMet.xml, and for ACBF support for panels, text and basic metadata. Other features include batch resize, page templates, and author data scraping.</dd>
This is the Comics Project Management Tools python plugin for Krita.
CPMT aims to simplify comics creation by:
* Giving the artist a way to organize and quickly access their pages.
* Helping the artist(s) deal with the boring bits meta data bits of a comic project by giving a meta-data editor that gives suggestions, explanation and occasionally a dab of humor.
* Making export set-and-forget type of affair where a single click can export to multiple formats with proper meta-data.
Export-wise, CPMT aims to support:
Advanced Comic Book Format
: An open comics format that has detailed markup as well as support for translations.
CBZ
: the most popular comic file format, with the following meta-data schemes:
* ACBF - as above.
* CoMet.xml
* ComicBookInfo (Spec is unclear so not 100% certain)
* ComicInfo.xml(Comic Rack)
Epub
: The epub publishing format. Not the most ideal format for handling comics, but most readers can open epub.
Usage - quick-start guide:
-------------------------
First, get the comic manager docker(settings → dockers → comic Management Docker). There, select *New Project*.
It will show a dialog asking for:
The project directory.
: This is where everything will be written to.
Concept
: so a simple sentence explaining what you want to write the comic about. This concept is just for you.
Project name.
: This is not the title, but more of a code name which will be used to create pages. For the impatient artist there is even a generator that produces code names.
Language
: The main language, used for all the meta data. By default set to the system locale.
Make a new directory with the project name.
: Whether to make a new project directory inside the selected directory. This allows you to have a generic comics directory that you always select and that CPMT will make directories named with the project name inside.
Pages
: The name for the directory to store the pages. This is where new pages are placed.
Export
: The name for the directory to store the export. This is where the comic will be exported to.
Templates
: The name for the directory to store the template. This is where the page templates get stored.
It will also allow you to edit meta data if you'd want already, but this is not mandatory.
Then after you finish, select *Open Project*, go to the location where you have stored your comics project. There should be a "comicsConfig.json" file there, next to the new folders for the pages, templates and export. Open that.
Now, click *Add Page* to add your first page. You will get a dialog asking for the template. Here you can generate one, or import one. CPMT will remember this as the default one.
Double click the new page to open in Krita.
The second column in the docker allows you to see the "subject" line in the document info if it's filled in.
You can press the arrow next to *Add Page* to get more features, like *Add Existing Page*, *Remove Page*, or *Batch Resize*.
Usage - Meta Data
------------------
You can edit the meta data by clicking the dropdown next to *Project Settings* and selecting *Meta Data*.
There's quite a few fields here, because there's quite a few different types of meta data. Hover over the fields to get an idea of what needs to be typed.
The meta data is intended to be filled out over the course of the project, so don't worry too much if you cannot instantly think of what a certain entry should be.
The meta data fields have auto completion wherever sensible. You can add your own meta data fields as noted in the following section:
### Adding extra auto-completion keys.
First, you need to go to project settings, and there point the extra keys to a folder where extra keys can be found.
It will search that extra folder for the following folders:
* key_genre
* key_format
* key_rating
* key_characters
* key_author_roles
* key_other
You can add extra auto-completion keys by adding a text file with each new key on a separate line to one of the "key" folders. The name of the text file doesn't matter. This way you can add characters by universe, or archive specific keywords by archive name.
So for example, the following file has three superhero names on different lines, nothing more, nothing less.
```
Spider-Man
Hawkeye
Jean Grey
```
When you then store it as marvel.txt put into the directory "key_characters", Krita will use the names from the list as suggestion for the character field in the meta-data.
The exception is the key_ratings, which uses CSV files, using the top row to determine the title, and then has the rating in the first column, and the description on the second. This allows the description to show up as tool-tips.
### The Author list
The author list is a table containing all the authors of the project. It allows a distinction between given, family, middle and nickname, as well as role, email and homepage.
You can rearrange the author list by drag and dropping the number at the left, as well as adding and removing authors.
Adding an author will always add "John Doe". You can double click the names and cells to change their contents. For the role, there are auto completion keys, so to encourage using standardized ways to describe their roles.
In the main docker, there's an option under the pages actions called *Scrape Authors*, this will make the comics project docker search the pages in the pages list for author info and append that to the author list. It will not attempt to check for duplicates, so be sure to the list afterwards.
Usage - Project Settings
-----------------------
The project settings allows you to change all the technical details of the project:
* the project name
* the concept
* the location of pages, export and templates
* the default template.
* the location of the extra auto-completion keys(see metadata)
Usage - Pages
-------------
There's several other things you can do with pages. You can either access these feature by clicking the drop-down next to *Add Page* or right-clicking the pages list.
Adding pages
: You can add pages by pressing the *Add Page* button. The first time you press this, it'll ask for a template. After you create or select a template it will use this as the default. You can set the default in the project settings.
Adding pages from template:
: Adding pages from a template will always give the template dialog. This will allow you to have several different templates in the templates directory(it will show all the kra files in the templates directory), so that you can have spread, coverpages and other pages at your finger tips. The create template dialog will allow you to make a simple two layer image with a white background, and rulers for the bleeds and guides. Import template will copy selected templates to the template directory, keeping all the necessary files inside the comics project.
Remove a page
: This allows you to remove the selected page in the list from the pages list. It does NOT delete the page from the disk.
Adding existing pages
: This is for when you wish to add existing pages, either because you removed the page from the list, or because you already have a project going and wish to add the pages to the list.
Batch Resize
: This will show a window with resize options. After selecting the right options, all the pages will be resized as such. A progress dialog will pop up showing you which pages have been done and how long it will take based on the passed time.
View Page in Window
: This will pop up a dialog with the selected page's mergedimage.png. The dialog will update when doing this for the image of another page. This is so that you can have a quick reference for a single page in the event your other referencing tools cannot open kra files.
Scrape Authors
: This searches all the files from the pages list for author information and adds that to the author list. It will not check for copies, so you will need to clean up the author list yourself.
Rearranging pages
: You can rearrange pages by moving the number on the left of the page up or down.
Usage - Copy Location
--------------------
Copy location, the button underneath the export button, allows you to copy the current project location to clipboard. Just press it, and paste somewhere else. This is useful when using multiple programs and reference tools and you just want to quickly navigate to the project directory.
Usage - Export
--------------
CPMT will not allow export without any export methods set.
You can configure the export settings by going to the drop-down next to *Project Settings* and selecting *Export Settings*.
Here you can define...
* how much a page needs to be cropped
* which layers to remove by layer color-label
* to which formats to export, in what file-format and how to resize.
Once you've done that, press export. Krita will pop up a progress bar for you with the estimated time and progress, so you can estimate how long you will have to wait.
CPMT will store the resized files and meta data in separate folders in the export folder. This is so that you can perform optimization methods afterwards and update everything quickly.
### ACBF ###
ACBF is the advanced comic book format. It is a metadata file that can hold extra data like panels and text, and can even store translations for the text.
Krita has some support for frames and text. If you name a vector layer "text" or "panels" it will search those for shapes. The shapes that are text nodes will be added to the ACBF file as a text in the main language of the comic, using the bounding box of the text-shape. The shapes that aren't text will have their bounding boxes used as frames. The order of frames and text is determined by the shape z-order in Krita, with the bottom shape being the first and the top shape being the last.
When you generate a CBZ file, the ACBF file will be generated alongside of it. There's in fact two ACBF files being generated: The one in the metadata folder is the ACBF file as it is inside the CBZ. The other ACBF file, next to the CBZ is the standalonefile. This file has the pages embedded, but there's currently fewer viewers who can read it.
To fine tune the export to ACBF, you can go to file->document Information and add the following keywords:
acbf_title
: this will flag this page to be used as a table of contents bookmark inside ACBF. The content mark will use the "title" value in the document information to create a bookmark in the project language.
acbf_none
: Sets the page transition value to "none" explicitly.
acbf_fade
: Sets the page transitio to fade. Viewers that support it will fade to black into this page.
acbf_blend
: Sets the page transition to blend. Viewers that support it will fade the previous page to this one.
acbf_horizontal
: Sets the page transition to scroll_right. Viewers that support it will scroll right to a new page.
acbf_vertical
: Sets the page transition to scroll_down. Viewers that support it will scroll down to a new page.
TODO:
======
Things I still want to do:
* Krita:
- Generate text from the author list. (Requires text api)
* clean up path relativeness. (Not sure how much better this can be done)
* Make label removal just a list? (unsure)
* PNG and JPEG export settings.
* maybe use python minidom for acbf(or export in general), because then we can create a prettier xml file, which is necessary for helping people edit the files in question. [partialy done, epub still needs this]
ACBF list:
* support getting text info from the vector layers. [Partially done]
- - users can specify a name for text layers. (Waiting for stringfreeze to end)
- Don't forget text-rotation(Needs API)
- - last two/five characters are used to determine language. (Maybe not a good idea...>_>)
- - maybe text-class can be used to determine type? (We'll proly need to use style sheets and comparing the text format to those)
- + Speech (speech, dialogue)
- + Commentary (caption in american comics)
- + Formal (For justified aligned text, like big chunks of text.)
- + Letter (Like a letter in a comic)
- + Code (Monospaced font)
- + Heading (Chapter title)
- + Audio (Only meant for audio devices)
- + Thought (Thought bubbles and the like)
- + Sign (For signs on buildings and the like.)
- + Inverted (Whether or not this should be treated as inverted text)
- + transparent(For a transparent wordballoon.)
- + Question: Where is general sound effects? Like, if we make a distinction between speech and thought, why are general sound effects missing? (Admittedly, I'd prefer if we could allow putting sound effects and such as a base64 reffed bit.) (See 1.2 support)
- + Probably also support acbf_order[n], where n is used to be the definitive value of the order.
- + Text class battle plan:
+ - Probably also support acbf_order[n], where n is used to be the definitive value of the order.
+ - Text class battle plan:
1. Support title and desc in vector shapes(c++)
2. Support editing them from a right-click "properties" window.
3. Support getting those values from python.
4. have acbf_textclass read from the desc.
- - Get page background color from the page if possible. (This might only work with canvas color, though)
- Jump: proly not gonna support this.
- - text url anchors: don't have a sensible interface for this.
+ - text url anchors: only used for references.
- Font embedding: spec is super vague about this.
- - Style sheets: needs a very complex gui.
- - database reference: I am not sure if this is at all relevant for Krita? Because it implies an already published comic.
- - acbf doc info should use author with first/nick/last/etc seperate as well[partially done]
- - text-layer background color(maybe sample topleft of projection???)
formLayers.addRow(i18n("Label for removal:"), self.cmbLabelsRemove)
+ self.ln_text_layer_name = QLineEdit()
+ self.ln_text_layer_name.setToolTip(i18n("These are keywords that can be used to identify text layers. A layer only needs to contain the keyword to be recognised. Keywords should be comma seperated."))
+ self.ln_panel_layer_name = QLineEdit()
+ self.ln_panel_layer_name.setToolTip(i18n("These are keywords that can be used to identify panel layers. A layer only needs to contain the keyword to be recognised. Keywords should be comma seperated."))
# ACBF, crop, resize, creator name, version history, panel layer, text layers.
ACBFExportSettings = QWidget()
ACBFform = QFormLayout()
ACBFExportSettings.setLayout(QVBoxLayout())
ACBFdocInfo = QGroupBox()
ACBFdocInfo.setTitle(i18n("ACBF Document Info"))
ACBFdocInfo.setLayout(ACBFform)
- self.lnACBFAuthor = QLineEdit()
- self.lnACBFAuthor.setToolTip(i18n("The person responsible for the generation of the CBZ."))
self.lnACBFSource = QLineEdit()
self.lnACBFSource.setToolTip(i18n("Whether the acbf file is an adaption of an existing source, and if so, how to find information about that source. So for example, for an adapted webcomic, the official website url should go here."))
self.lnACBFID = QLabel()
self.lnACBFID.setToolTip(i18n("By default this will be filled with a generated universal unique identifier. The ID by itself is merely so that comic book library management programs can figure out if this particular comic is already in their database and whether it has been rated. Of course, the UUID can be changed into something else by manually changing the json, but this is advanced usage."))
self.spnACBFVersion = QSpinBox()
self.ACBFhistoryModel = QStandardItemModel()
acbfHistoryList = QListView()
acbfHistoryList.setModel(self.ACBFhistoryModel)
btn_add_history = QPushButton(i18n("Add history entry"))
+ self.chkIncludeTranslatorComments.setToolTip(i18n("A PO file can contain translator's comments. If this is checked, the translations comments will be added as references into the ACBF file."))
- # TODO: Rotate will require proper global transform api as transform info is not written intotext. #textArea.setAttribute("text-rotation", str(v["rotate"]))
self.lnGenre.setToolTip(i18n("The genre of the work. Prefilled values are from the ACBF, but you can fill in your own. Separate genres with commas. Try to limit the amount to about two or three"))
explanation = QLabel(i18n("The following is a table of the authors that contributed to this comic. You can set their nickname, proper names (first, middle, last), Role (Penciller, Inker, etc), email and homepage."))
+ self.ln_database_name.setToolTip(i18n("If there's an entry in a comics data base, that should be added here. It is unlikely to be a factor for comics from scratch, but useful when doing a conversion."))
It allows people to create comics project files, load those files, add pages, remove pages, move pages, manage the metadata,
and finally export the result.
The logic behind this docker is that it is very easy to get lost in a comics project due to the massive amount of files.
By having a docker that gives the user quick access to the pages and also allows them to do all of the meta-stuff, like
meta data, but also reordering the pages, the chaos of managing the project should take up less time, and more time can be focussed on actual writing and drawing.
self.action_scrape_authors.setToolTip(i18n("Search for author information in documents and add it to the author list. This doesn't check for duplicates."))
This allows users to select existing pages and add them to the pages list. The pages are currently not copied to the pages folder. Useful for existing projects.
if os.path.exists(os.path.join(self.projecturl, templateUrl)):
templateExists = True
if templateExists is False:
if "templateLocation" not in self.setupDictionary.keys():
self.setupDictionary["templateLocation"] = os.path.relpath(QFileDialog.getExistingDirectory(caption=i18n("Where are the templates located?"), options=QFileDialog.ShowDirsOnly), self.projecturl)
if os.path.exists(os.path.join(self.projecturl, templateUrl)):
self.add_new_page(templateUrl)
"""
This function always asks for a template showing the new template window. This allows users to have multiple different
templates created for back covers, spreads, other and have them accesible, while still having the convenience of a singular
"add page" that adds a default.
"""
def slot_add_new_page_from_template(self):
if "templateLocation" not in self.setupDictionary.keys():
self.setupDictionary["templateLocation"] = os.path.relpath(QFileDialog.getExistingDirectory(caption=i18n("Where are the templates located?"), options=QFileDialog.ShowDirsOnly), self.projecturl)
This is the actual function that adds the template using the template url.
It will attempt to name the new page projectName+number.
"""
def add_new_page(self, templateUrl):
# check for page list and or location.
pagesList = []
if "pages" in self.setupDictionary.keys():
pagesList = self.setupDictionary["pages"]
if not "pageNumber" in self.setupDictionary.keys():
self.setupDictionary['pageNumber'] = 0
if (str(self.setupDictionary["pagesLocation"]).isspace()):
self.setupDictionary["pagesLocation"] = os.path.relpath(QFileDialog.getExistingDirectory(caption=i18n("Where should the pages go?"), options=QFileDialog.ShowDirsOnly), self.projecturl)
# Search for the possible name.
extraUnderscore = str()
if str(self.setupDictionary["projectName"])[-1].isdigit():
templateUrl = os.path.relpath(QFileDialog.getOpenFileName(caption=i18n("Which image should be the basis the new page?"), directory=self.projecturl, filter=str(i18n("Krita files") + "(*.kra)"))[0], self.projecturl)
self.pagesLocation = path_select(question=i18n("Where should the pages go?"), projectUrl=self.projectUrl)
self.exportLocation = path_select(question=i18n("Where should the export go?"), projectUrl=self.projectUrl)
self.templateLocation = path_select(question=i18n("Where are the templates?"), projectUrl=self.projectUrl)
+ self.translationLocation = path_select(question=i18n("Where are the translations?"), projectUrl=self.projectUrl)
self.keyLocation = path_select(question=i18n("Where are the extra auto-completion keys located?"))
self.keyLocation.setToolTip(i18n("The location for extra autocompletion keys in the meta-data editor. Point this at a folder containing key_characters/key_format/key_genre/key_rating/key_author_roles/key_other with inside txt files(csv for tating) containing the extra auto-completion keys, each on a new line. This path is stored in the krita configuration, and not the project configuration."))
self.lnProjectName.setToolTip(i18n("A Project name. This can be different from the eventual title"))
btnRandom = QPushButton()
btnRandom.setText(i18n("Generate"))
btnRandom.setToolTip(i18n("If you cannot come up with a project name, our highly sophisticated project name generator will serve to give a classy yet down to earth name."))
btnRandom.clicked.connect(self.slot_generate)
projectLayout.addWidget(self.lnProjectName)
projectLayout.addWidget(btnRandom)
lnConcept = QLineEdit()
lnConcept.setToolTip(i18n("What is your comic about? This is mostly for your own convenience so don't worry about what it says too much."))
- self.chkMakeProjectDirectory = QCheckBox(i18n("Make a new directory with the project name."))
- self.chkMakeProjectDirectory.setToolTip(i18n("This allows you to select a generic comics project directory, in which a new folder will be made for the project using the given project name."))
+ self.chkMakeProjectDirectory = QCheckBox()
+ labelDirectory = QLabel(i18n("Make a new directory with the project name."))
+ labelDirectory.setWordWrap(True)
+ stringDirectoryTooltip = i18n("This allows you to select a generic comics project directory, in which a new folder will be made for the project using the given project name.")
filenames = QFileDialog.getOpenFileNames(caption=i18n("Which files should be added to the template folder?"), directory=self.templateDirectory, filter=str(i18n("Krita files") + "(*.kra)"))[0]
explanation = QLabel(i18n("This allows you to make a template document with guides.\nThe width and height are the size of the live-area, the safe area is the live area minus the margins, and the full image is the live area plus the bleeds."))
+ # TODO: Rotate will require proper global transform api as transform info is not written intotext. #textArea.setAttribute("text-rotation", str(v["rotate"]))
+ # TODO: Rotate will require proper global transform api as transform info is not written intotext. #textArea.setAttribute("text-rotation", str(v["rotate"]))
QMessageBox::warning(this, i18n("Conversion failed"), "Could not get svg text from the shape:\n" + converter.errors().join('\n') + "\n" + converter.warnings().join('\n'));
}
}
}
void SvgTextEditor::save()
{
if (m_shape) {
if (m_textEditorWidget.textTab->currentIndex() == Richtext) {