Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

usermanual : iop layouts #6576

Merged
merged 3 commits into from
Oct 21, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions doc/usermanual/darkroom/darkroom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@
On the left hand side you have navigation, snapshot, history stack, color picker, tagging,
image information and mask manager panels, described in <xref linkend="darkroom_panels"/>.
In the right hand panel you can see the histogram and a list of modules available for
working with the image. At the bottom of the right hand panel you can enable/disable the
view of individual modules.
working with the image.
</para>

<indexterm>
Expand Down
Binary file removed doc/usermanual/darkroom/images/darkroom_group_basic.png
Binary file not shown.
Binary file removed doc/usermanual/darkroom/images/darkroom_group_color.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/usermanual/darkroom/images/darkroom_group_tone.png
Binary file not shown.
Binary file modified doc/usermanual/darkroom/images/panel_modulegroups.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/usermanual/darkroom/images/panel_moremodules.png
Binary file not shown.
36 changes: 0 additions & 36 deletions doc/usermanual/darkroom/modules/basic/group_basic.xml

This file was deleted.

35 changes: 0 additions & 35 deletions doc/usermanual/darkroom/modules/color/group_color.xml

This file was deleted.

47 changes: 0 additions & 47 deletions doc/usermanual/darkroom/modules/correction/group_correction.xml

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,35 +1,44 @@
<sect2 status="final" id="effect_group">
<sect2 status="final" id="effects_group">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we need to update the integrated help (when clicking on ?) as links have changed? Probably true for many other changes here I think.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh... forgot that... But yes, there should be many links to change (at least all the iops...) I'll have a look !

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm... so it seems I have tons of links to change in usermanual_url.c (basically each iop link as changed)
problem : once they are changed, they will point to invalid urls until we release the manual... should I do this anyway ? or should we postponed it ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say no big deal. The current master is for advanced users who don't need the help I suppose or can live without it for some time. And I do plan to publish the 3.4 manual at the same time as the release this year.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done. and in the same time I've fixed lot of invalid urls or missing ones. Surprising that no user raise issues... Maybe a sign that this feature is underutilized ?


<title>Effect group</title>
<title>Effects group</title>

<para>
In the effect group you will find modules with a more artistic touch.
The effects group contain the weird kids
(local contrast, sharpness, high/low-freq, retouch, liquify, etc.)
</para>

<xi:include href="watermark.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="framing.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="splittoning.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="vignetting.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="soften.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="grain.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="highpass.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="lowpass.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="monochrome.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="lowlight.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="bloom.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="colorize.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="localcontrast.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="colormapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="graduatedneutraldensity.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="sharpen.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="highpass.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="lowpass.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="equalizer.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="retouch.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="spotremoval.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="liquify.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

</sect2>
54 changes: 54 additions & 0 deletions doc/usermanual/darkroom/modules/grading/group_grading.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<sect2 status="final" id="grading_group">

<title>Grading group</title>

<para>
The grading group contains every module to be used artistically and doing color
and tones corrective and creative work (including chromatic adaptation / white balance)
</para>

<xi:include href="splittoning.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="colorize.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="colorzones.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="vibrance.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="velvia.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="colorcontrast.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="colorcorrection.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="filllight.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="global_tonemap.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="zonesystem.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="shadhi.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="levels.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="tonecurve.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="colisa.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="rgblevels.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="rgbcurve.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="colorbalance.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="channelmixer.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="graduatedneutraldensity.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="toneequalizer.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="tonemapping.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="whitebalance.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

</sect2>
14 changes: 5 additions & 9 deletions doc/usermanual/darkroom/modules/modules.xml
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,17 @@
</indexterm>

<para>
Modules are organized into five functional groups: basic, tone, color, correction and
effect. You either view all modules in one long list or instead click on a group to just
With the default preset, modules are organized into three functional groups: technical, grading and effects.
You either view all modules in one long list or instead click on a group to just
display modules belonging to that group.
</para>

<!-- Modules groups -->

<xi:include href="basic/group_basic.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="technical/group_technical.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="tone/group_tone.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="grading/group_grading.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="color/group_color.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="correction/group_correction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="effect/group_effect.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="effects/group_effects.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

</sect1>
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@
When activated the automatic cropping feature clips the image to get rid of any black
corners. At your choice you can either clip to the <quote>largest area</quote> or to the
largest rectangle maintaining the original aspect ratio (<quote>original
format</quote>). In the latter case you can manually adjust the automatic cropping result:
format</quote>). In the latter case you can manually adjust the automatic cropping result:
left click into to clip region and move it around. The size of the region gets modified
automatically excluding any black corners.
</para>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
more details see <xref linkend="darktable_commandline_parameters"/>. If you generate your
own noise profiles don't forget to share your results with the darktable team!
</para>

<para>
/!\ WARNING /!\
The darkroom zoomed out preview is not completely accurate. Always check your result at 100% zoom level!
Expand Down Expand Up @@ -145,7 +145,7 @@
parameter. A lower value will make execution faster, a higher value will make it slower.
</para>
</sect5>

<sect5>
<title>scattering</title>
<para>
Expand All @@ -157,7 +157,7 @@
chroma noise.
</para>
</sect5>

<sect5>
<title>central pixel weight</title>
<para>
Expand Down Expand Up @@ -221,7 +221,7 @@
within your image.
</para>
</sect5>

<sect5>
<title>preserve shadows</title>
<para>
Expand All @@ -231,7 +231,7 @@
value.
</para>
</sect5>

<sect5>
<title>bias correction</title>
<para>
Expand Down
68 changes: 68 additions & 0 deletions doc/usermanual/darkroom/modules/technical/group_technical.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
<sect2 status="final" id="technical_group">

<title>Technical group</title>

<para>
The technical group contains every module bounded by some physical reality:
lens, sensor, in/out color spaces and various signal reconstructions (highlights, noise, etc.)
</para>

<xi:include href="dithering.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="outputcolorprofile.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="color_reconstruction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="filmicrgb.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="basecurve.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="lut3d.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="defringe.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="colorchecker.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="denoise_nlm.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="negadoctor.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="inputcolorprofile.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="exposure.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="crop_and_rotate.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="orientation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="ashift.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="hazeremoval.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="unbreakinputprofile.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="lenscorrection.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="scalepixels.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="rotatepixels.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="denoise_bilateral.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="denoise_profiled.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="demosaic.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="rawdenoise.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="hotpixels.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="chromatic.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="highlightreconstruction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="invert.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

<xi:include href="raw_black_white.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>

</sect2>
Loading