Enhance auto-rename functionality with additional options #1604
Conversation
- Added ability to rename files based on the content of specific lines. - Implemented renaming based on text between specified markers. - Added option to rename files using content from specific line numbers. - Enabled renaming based on text before or after a specified keyword. - Included regex-based renaming to allow more complex patterns.
github-actions
bot
added
Java
| <div class="form-group"> | ||
| <label for="useAfter">Text to use:</label> | ||
| <select class="form-control" id="useAfter" name="useAfter"> | ||
| <option value="false">Entire line containing keyword</option> |
There was a problem hiding this comment.
all text should use translation feature
ie
the:text="#{auto-rename.useAfter.false}"
| <br> | ||
| <div class="form-group"> | ||
| <label for="useAfter">Text to use:</label> | ||
| <select class="form-control" id="useAfter" name="useAfter"> |
There was a problem hiding this comment.
Might be good to support text before key word, and or regex as well
| @@ -20,8 +20,29 @@ | |||
| <form method="post" enctype="multipart/form-data" th:action="@{'/api/v1/misc/auto-rename'}"> | |||
| <div th:replace="~{fragments/common :: fileSelector(name='fileInput', multiple=false, accept='application/pdf')}"></div> | |||
| <br> | |||
| <div class="form-group"> | |||
| <label for="keyword">Keyword:</label> | |||
| <input type="text" class="form-control" id="keyword" name="keyword" placeholder="e.g., Company, Name, Invoice" required> | |||
There was a problem hiding this comment.
What about if people want to auto grab the title without using any keywords like previous functionality, we still need to support that and make it clear to use this is option,
Perhaps a param to change from
Autodetect from title vs using keyword
and have options show based on that
| @@ -16,4 +18,9 @@ public class ExtractHeaderRequest extends PDFFile { | |||
| required = false, | |||
| defaultValue = "false") | |||
| private boolean useFirstTextAsFallback; | |||
|
|
|||
| private MultipartFile fileInput; | |||
There was a problem hiding this comment.
this multiFile input is already part of this class... its from PDFFile that's extended
| @@ -16,4 +18,9 @@ public class ExtractHeaderRequest extends PDFFile { | |||
| required = false, | |||
| defaultValue = "false") | |||
| private boolean useFirstTextAsFallback; | |||
|
|
|||
| private MultipartFile fileInput; | |||
| private String keyword; | |||
There was a problem hiding this comment.
Any API documentation for these?
| @@ -16,4 +18,9 @@ public class ExtractHeaderRequest extends PDFFile { | |||
| required = false, | |||
| defaultValue = "false") | |||
| private boolean useFirstTextAsFallback; | |||
|
|
|||
| private MultipartFile fileInput; | |||
There was a problem hiding this comment.
fileInput already included via extended PDFFile
Enhance auto-rename functionality with additional options
Description
This pull request enhances the auto-rename functionality by adding keyword-based renaming options and a fallback mechanism. The updates are motivated by the need for more flexible and user-friendly file renaming methods, especially when dealing with documents that lack meaningful filenames or metadata.
Summary of Changes
Keyword-Based Renaming:
Entire Line Containing Keyword: The filename is generated using the entire line that contains the specified keyword.
Text After Keyword: The filename is generated using the text that follows the specified keyword.
Fallback Method:
If no suitable filename is found using the keyword-based method, the existing method that renames based on the largest font is used as a fallback.
Motivation and Context
User Flexibility: The enhancement allows users to specify keywords for more precise and meaningful filenames, catering to various document types and user preferences.
Practical Use Cases: Examples include renaming payslips based on date or company name, making it easier to manage and locate specific documents.
Improved Usability: The fallback mechanism ensures that the renaming process remains robust even if the keyword-based method does not yield a suitable filename.
Implementation Details
Files Updated:
auto-rename.html
AutoRenameController.java
ExtractHeaderRequest.java
Approach: The implementation checks for the presence of specified keywords first. If no keywords are provided or no matches are found, the process falls back to the original method of using the largest font for renaming.
Testing
Test Cases: Tested with documents having various structures and content to ensure the keyword-based renaming and fallback methods work correctly.
Results: The changes have been verified to work as intended, providing more accurate and meaningful filenames based on user-specified keywords.
Please review the changes and let me know if there are any additional adjustments or improvements needed. Your feedback is highly appreciated.
Closes #(issue_number)
##Screenshots
The filename is generated using the entire line that contains the specified keyword (Entire line containing keyword).
Line containing after keyword
If no suitable filename is found using the keyword-based method, the existing method that renames based on the largest font is used as a fallback.
Checklist:
Contributor License Agreement
By submitting this pull request, I acknowledge and agree that my contributions will be included in Stirling-PDF and that they can be relicensed in the future under the MPL 2.0 (Mozilla Public License Version 2.0) license.
(This does not change the general open-source nature of Stirling-PDF, simply moving from one license to another license)