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

[FR] Collaboration and integration for my new plugin #304

Open
tu2-atmanand opened this issue Nov 27, 2024 · 0 comments
Open

[FR] Collaboration and integration for my new plugin #304

tu2-atmanand opened this issue Nov 27, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@tu2-atmanand
Copy link

tu2-atmanand commented Nov 27, 2024

Describe your request

Hii @RyotaUshio,

I was actually planning for a plugin to manage all my local books from a long time, more of like a Library Management system. Also, one of the most important feature the plugin should have is Speech Reading similar to Speechify.

Initially, I thought of creating a plugin just for creating a View and the Management stuff. And another part will be for Speech Reader controls inside the reader. So, I had options to refer to other plugins like Awesome Reader, Annotator, etc (which also has support for EPUB files). But having a simple reader won't be a good idea, and having an annotator to highlight and take notes will provide a great power to the user to add annotations while listening to their books. And I must say, your plugin has the best features for doing the same and giving the best experience to users.

Hence I started the development of my plugin by creating fork from PDF++ : Library - plugin for Obsidian

Reasons for creating a fork :

  • I was actually wondering if PDF++ could develop few APIs, so all the annotations and editing features can be integrated through PDF++ and Library plugin will be only for management and Speech Reader. But since in an open-source environment, we obviously cannot rely on anyone here to achieve what we want.
  • I will try to integrate your codebase into the Library plugin functionalities by creating various APIs in PDF++ codebase. Later on, I can create a PR for you to integrate all this APIs in PDF++.
  • I want to implement the Speech Reader feature (explaned in detail on my repo Readme) into PDF++ itself so both the annotations and Speech reading works smoothly. I will create a PR for this as well to have the same functionality in PDF++, or I can create a separate plugin also, so it will be compatible with PDF++, so users can install it only if they want it.

Once all the above mentioned tasks has been accomplished. I will remove all the PDF++ features from Library plugin. So, Library plugin can only work as a management tool and a Speech Reader. And if users want annotations power, they can install the PDF++, and it will be seemlessly work with Library plugin.

Roadmap

So, here what I am suggesting to have an efficient roadmap :

  • I'll try to integrate my functionalities with the current state of PDF++( v0.40.13 ).
  • Ill create some APIs in PDF++ codebase, which will be crucial for Library plugin to work with PDF++. And will create a PR for the same.
  • Later will also create issues to request for more APIs, to integrate the further features, you have planned from your Issues section in the future.
  • Ill try to implement the Speech Reader functionality, and will create a PR to complete the following issue : [FR] TTS Support #299
  • Later, my plugin will only act as a management tool and for speech reader and for the annotation and rest of the functionalities users can install your plugin.

Let me know your thoughts on this and also what are you plans to have the epub support. I referred plugins like ePub Reader, Awesome Reader and Annotator. I personally feel, you can refer to the best approach from this plugins, and integrate epub support in PDF++ such that your current implementation of PDF++ will also work with epub files, like Auto-pasting, auto-focus, etc. Still I am not sure, I dont have much experience in epub files, nor have used them much, so wont be working on that part for Library plugin, relying on you to have the integration of epub file support.

@tu2-atmanand tu2-atmanand added the enhancement New feature or request label Nov 27, 2024
@tu2-atmanand tu2-atmanand changed the title [FR] [FR] Collaboration and integration for my new plugin Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant