Add documentation, cleanup

docs/api.md

@@ -376,6 +376,18 @@ The following methods are supported:
     - `"merge": true or false` (defaults to false)
   - The `merge` flag determines if the supplied permissions will overwrite all existing permissions (including
     removing them) or be merged with existing permissions.
+- `merge`
+  - No additional `parameters` required.
+  - The ordering of the merged document is determined by the list of IDs.
+  - Optional `parameters`:
+    - `"metadata_document_id": DOC_ID` apply metadata (tags, correspondent, etc.) from this document to the merged document.
+- `split`
+  - Requires `parameters`:
+    - `"pages": [..]` The list should be a list of pages and/or a ranges, separated by commas e.g. `"[1,2-3,4,5-7]"`
+  - The split operation only accepts a single document.
+- `rotate`
+  - Requires `parameters`:
+    - `"degrees": DEGREES`. Must be an integer i.e. 90, 180, 270
 
 ### Objects
 

docs/usage.md

@@ -456,6 +456,14 @@ Paperless-ngx added the ability to create shareable links to files in version 2.
 
     If your paperless-ngx instance is behind a reverse-proxy you may want to create an exception to bypass any authentication layers that are part of your setup in order to make links truly publicly-accessible. Of course, do so with caution.
 
+## PDF Actions
+
+Paperless-ngx supports 3 basic editing operations for PDFs (these operations cannot be performed on non-PDF files):
+
+- Merging documents: available when selecting multiple documents for 'bulk editing'
+- Rotating documents: available when selecting multiple documents for 'bulk editing'. Note that rotation alters the source file.
+- Splitting documents: available from an individual documents details page
+
 ## Best practices {#basic-searching}
 
 Paperless offers a couple tools that help you organize your document

src-ui/src/app/components/common/confirm-dialog/merge-confirm-dialog/merge-confirm-dialog.component.html

@@ -2,8 +2,8 @@
     <h4 class="modal-title" id="modal-basic-title">{{title}}</h4>
     <button type="button" class="btn-close" aria-label="Close" (click)="cancel()">
     </button>
-  </div>
+</div>
-  <div class="modal-body">
+<div class="modal-body">
     <p>{{message}}</p>
     <div class="form-group">
         <label class="form-label" for="metadataDocumentID" i18n>Documents:</label>
@@ -28,23 +28,12 @@
         </select>
     </div>
     <p class="small text-muted fst-italic mt-4" i18n>Note that only PDFs will be included.</p>
-  </div>
+</div>
-  <div class="modal-footer">
+<div class="modal-footer">
     <button type="button" class="btn" [class]="cancelBtnClass" (click)="cancel()" [disabled]="!buttonsEnabled">
         <span class="d-inline-block" style="padding-bottom: 1px;">{{cancelBtnCaption}}</span>
     </button>
     <button type="button" class="btn" [class]="btnClass" (click)="confirm()" [disabled]="!confirmButtonEnabled || !buttonsEnabled">
-      <span>
         {{btnCaption}}
-        <span class="visually-hidden">{{ seconds | number: '1.0-0' }} seconds</span>
-      </span>
-      @if (!confirmButtonEnabled) {
-        <ngb-progressbar style="height: 1px;" type="dark" [max]="secondsTotal" [value]="seconds"></ngb-progressbar>
-      }
     </button>
-    @if (alternativeBtnCaption) {
+</div>
-      <button type="button" class="btn" [class]="alternativeBtnClass" (click)="alternative()" [disabled]="!alternativeButtonEnabled || !buttonsEnabled">
-        {{alternativeBtnCaption}}
-      </button>
-    }
-  </div>

src-ui/src/app/components/common/confirm-dialog/rotate-confirm-dialog/rotate-confirm-dialog.component.html

@@ -2,8 +2,8 @@
     <h4 class="modal-title" id="modal-basic-title">{{title}}</h4>
     <button type="button" class="btn-close" aria-label="Close" (click)="cancel()">
     </button>
-  </div>
+</div>
-  <div class="modal-body">
+<div class="modal-body">
     <div class="row">
         <div class="col-3 d-flex justify-content-end">
             <button class="btn btn-secondary mt-auto" (click)="rotate(false)">
@@ -31,23 +31,16 @@
             }
         </div>
     </div>
-  </div>
+    <p class="small text-muted fst-italic mt-4" i18n>Note that only PDFs will be rotated.</p>
-  <div class="modal-footer">
+</div>
+<div class="modal-footer">
     <button type="button" class="btn" [class]="cancelBtnClass" (click)="cancel()" [disabled]="!buttonsEnabled">
         <span class="d-inline-block" style="padding-bottom: 1px;">{{cancelBtnCaption}}</span>
     </button>
     <button type="button" class="btn" [class]="btnClass" (click)="confirm()" [disabled]="!confirmButtonEnabled || !buttonsEnabled">
-      <span>
       {{btnCaption}}
-        <span class="visually-hidden">{{ seconds | number: '1.0-0' }} seconds</span>
-      </span>
       @if (!confirmButtonEnabled) {
           <ngb-progressbar style="height: 1px;" type="dark" [max]="secondsTotal" [value]="seconds"></ngb-progressbar>
       }
     </button>
-    @if (alternativeBtnCaption) {
+</div>
-      <button type="button" class="btn" [class]="alternativeBtnClass" (click)="alternative()" [disabled]="!alternativeButtonEnabled || !buttonsEnabled">
-        {{alternativeBtnCaption}}
-      </button>
-    }
-  </div>

src-ui/src/app/components/common/confirm-dialog/split-confirm-dialog/split-confirm-dialog.component.html

@@ -2,8 +2,8 @@
     <h4 class="modal-title" id="modal-basic-title">{{title}}</h4>
     <button type="button" class="btn-close" aria-label="Close" (click)="cancel()">
     </button>
-  </div>
+</div>
-  <div class="modal-body">
+<div class="modal-body">
     <p>{{message}}</p>
     <div class="row mb-2">
         <div class="col-6">
@@ -44,12 +44,12 @@
             </ul>
         </div>
     </div>
-  </div>
+</div>
-  <div class="modal-footer">
+<div class="modal-footer">
     <button type="button" class="btn" [class]="cancelBtnClass" (click)="cancel()" [disabled]="!buttonsEnabled">
             <span class="d-inline-block" style="padding-bottom: 1px;">{{cancelBtnCaption}}</span>
         </button>
     <button type="button" class="btn" [class]="btnClass" (click)="confirm()" [disabled]="!confirmButtonEnabled || !buttonsEnabled">
         {{btnCaption}}
     </button>
-  </div>
+</div>