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

Writer EPub3 : Added support #2724

Merged
merged 19 commits into from
Feb 3, 2025

Conversation

Sambit003
Copy link
Contributor

@Sambit003 Sambit003 commented Jan 10, 2025

Description

Implemented ePub3 writer support

Fixes #55
/claim #55

Checklist:

  • My CI is 🟢
  • I have covered by unit tests my new code (check build/coverage for coverage report)
  • I have updated the documentation to describe the changes
  • I have updated the changelog

@coveralls
Copy link

coveralls commented Jan 17, 2025

Coverage Status

coverage: 96.748% (-0.2%) from 96.947%
when pulling f8f0c83 on Sambit003:feat/add-epub3-writer
into 337dc27 on PHPOffice:master.

@algora-pbc algora-pbc bot mentioned this pull request Jan 17, 2025
@Sambit003 Sambit003 marked this pull request as ready for review January 17, 2025 19:02
@Sambit003
Copy link
Contributor Author

@Progi1984 can you please review this PR?

@Sambit003
Copy link
Contributor Author

image

And also look at this checking procedure I was running in local. There are some deprecated unit tests. What to do about that?

@Progi1984
Copy link
Member

@Sambit003 Could you implement basic Text and Image Elements ?

No need styles.

I just want that Epub generated contains image and text.

After that, I can review.

@Sambit003
Copy link
Contributor Author

@Sambit003 Could you implement basic Text and Image Elements ?

No need styles.

I just want that Epub generated contains image and text.

After that, I can review.

Sure. Then i'm removing the part of the style. Already the text and image element part is there. Again I will give it a thorough check.

@Progi1984
Copy link
Member

Let the basic style you made. It's perfect in a first time.

@Sambit003
Copy link
Contributor Author

Let the basic style you made. It's perfect in a first time.

Yeah okay

@Sambit003
Copy link
Contributor Author

@Progi1984 I've added the Text and Image element implementation. I'm working on unit tests and conventions. Will push those soon.

@Sambit003
Copy link
Contributor Author

@Progi1984 Hi, I've implemented the features and Unit tests you've asked. Can you please review it?

@Progi1984 Progi1984 changed the title Feat: Added Epub3 writer support Writer EPub3 : Added support Jan 22, 2025
composer.json Outdated Show resolved Hide resolved
Copy link
Member

@Progi1984 Progi1984 left a comment

Choose a reason for hiding this comment

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

Some feedbacks, but it's a good job.

Could you send me a sample generated file ? (May be the samples/Sample_01_SimpleText.php)

I want to check it with epubcheck (https://www.w3.org/publishing/epubcheck/).

Don't forget to update the changelog (https://github.com/PHPOffice/PHPWord/blob/master/docs/changes/1.x/1.4.0.md).

@Sambit003
Copy link
Contributor Author

Could you send me a sample generated file ? (May be the samples/Sample_01_SimpleText.php)

Oh, I've missed that part. I'll make the necessary changes needed. And will upload the epub file here once it's ready

composer.json Outdated Show resolved Hide resolved
@Progi1984
Copy link
Member

Some feedbacks, but it's a good job.

Could you send me a sample generated file ? (May be the samples/Sample_01_SimpleText.php)

I want to check it with epubcheck (https://www.w3.org/publishing/epubcheck/).

Don't forget to update the changelog (https://github.com/PHPOffice/PHPWord/blob/master/docs/changes/1.x/1.4.0.md).

Need that :)

@Sambit003
Copy link
Contributor Author

Some feedbacks, but it's a good job.
Could you send me a sample generated file ? (May be the samples/Sample_01_SimpleText.php)
I want to check it with epubcheck (https://www.w3.org/publishing/epubcheck/).
Don't forget to update the changelog (https://github.com/PHPOffice/PHPWord/blob/master/docs/changes/1.x/1.4.0.md).

Need that :)

Yes. Was unavailable due to some personal reasons. I'm working on that part now.

@Sambit003
Copy link
Contributor Author

Sambit003 commented Feb 1, 2025

Some feedbacks, but it's a good job.
Could you send me a sample generated file ? (May be the samples/Sample_01_SimpleText.php)
I want to check it with epubcheck (https://www.w3.org/publishing/epubcheck/).
Don't forget to update the changelog (https://github.com/PHPOffice/PHPWord/blob/master/docs/changes/1.x/1.4.0.md).

Need that :)

I can't upload the generated epub file. It's not supported
image

But, i've checked with the tool you've mentioned and changed the required codebase according to that with unit tests.

@Sambit003
Copy link
Contributor Author

@Progi1984 Can you please review now?

@Sambit003
Copy link
Contributor Author

For your reference:
1.
image

image

image

@Progi1984
Copy link
Member

It's nearly perfect job.

My last : update the changelog. And it will be ok for me.

@Sambit003
Copy link
Contributor Author

It's nearly perfect job.

My last : update the changelog. And it will be ok for me.

Changelog is updated

@Progi1984
Copy link
Member

@Sambit003 I will merge it on Monday. I'm not in front of my computer.

💕 For all your work.

@Progi1984 Progi1984 merged commit 5914e8e into PHPOffice:master Feb 3, 2025
30 checks passed
@Sambit003
Copy link
Contributor Author

@Sambit003 I will merge it on Monday. I'm not in front of my computer.

💕 For all your work.

@Progi1984 Thank you for merging❤️. It was really nice to work with you and also learnt something new here.

And can you please tell me that when I'll receive that bounty claim? Like this one is my first so.

@Progi1984
Copy link
Member

@Sambit003 It's done, NOW 😛

🎉 Congratulations for my first bounty and your first bounty 🎉

@Sambit003
Copy link
Contributor Author

@Sambit003 It's done, NOW 😛

🎉 Congratulations for my first bounty and your first bounty 🎉

Thanks bro🤪❤️❤️. And also i would love to work on the style part.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

Implement ePub3 Writer
3 participants