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

Update Requirments in the Readme #120

Closed
hskrtich opened this issue Mar 13, 2014 · 29 comments · Fixed by #121
Closed

Update Requirments in the Readme #120

hskrtich opened this issue Mar 13, 2014 · 29 comments · Fixed by #121

Comments

@hskrtich
Copy link
Contributor

Please update the requirement in the ReadMe to include:

PHP Extension ZipArchive
PHP Extension libxml

@ivanlanin
Copy link
Contributor

I've put the requirement for ZipArchive in the README. Where do we use libxml? CMIIW, I think we're using DOMDocument and SimpleXML.

@hskrtich
Copy link
Contributor Author

Looking at the code, it uses XMLWriter and XMLWriter requires libxml. So instead of libxml we should list XMLWriter. Also it would be a good idea to update composer.json with these requirements.

@ivanlanin
Copy link
Contributor

Yup. You're right. So we should move ext-zip from recommend to require in composer.json?

@hskrtich
Copy link
Contributor Author

Yes until someone (maybe me) adds PCL ZIP support.

@ivanlanin
Copy link
Contributor

PHPWord users will like it when you can't sleep ;)

@Progi1984
Copy link
Member

@ivanlanin @bskrtich Could you send a pull request for the readme.MD and the composer.json ? Thanks :)

@Progi1984 Progi1984 added this to the 0.7.1 milestone Mar 13, 2014
@Progi1984
Copy link
Member

I think it is rather recommandations rather than requirements. Why ? Imagine a developer which only want to generate RTF Files and no ODT/DOCX files.

@hskrtich
Copy link
Contributor Author

For both zip & xml, correct?

@Progi1984
Copy link
Member

Yes... What do you think about that ?

@hskrtich
Copy link
Contributor Author

Sounds reasonable to me. I will make the change now.

@ivanlanin
Copy link
Contributor

Yes, we don't need xml and zip for RTF. But, why would anyone use PHPWord (with the Word) if they want to create a RTF file? Because they can't find PHPRtfLite? :) Btw, we can use some of their codes.

@Progi1984
Copy link
Member

@ivanlanin I agree with you but in the future, I hope we support DOC file format which no needs XML & ZIP, like HTML, WPS or PDF. I think that the requirement for a writer/reader must be precised in the documentation

@ghost
Copy link

ghost commented Mar 13, 2014

But, why would anyone use PHPWord (with the Word) if they want to create a RTF file? Because they can't find PHPRtfLite?

Why not, @ivanlanin?

@ivanlanin
Copy link
Contributor

Haha. Alright. I think we will have to make our RTF Writer better, then.

@Progi1984
Copy link
Member

@ivanlanin A good objective. Don't hesitate to create issues with missing features.

@Progi1984
Copy link
Member

@ivanlanin @RomanSyroeshko @bskrtich
Finally, what do you think about that : requirements ? recommandations + documentation ?

@ivanlanin
Copy link
Contributor

I admit that there's a possibility that people will use PHPWord only for creating RTFs, but I still think that most people will use PHPWord to create Word documents. RTF creation is an extra feature for us. So, I support @bskrtich pull request #121

@ghost
Copy link

ghost commented Mar 14, 2014

On the one hand, I agree that "ext-zip" and "ext-xml" should be optional in common case. Our documentation should be clear enough about usage of the extensions. Users should understand what the extensions are used for, and when they should be enabled.

On the other hand, at the current moment PHPWord works witn OOXML and ODT. These formats require ZIP and XML extensions.

So, I suggest consider that XML and ZIP extensions are required for now, because it's true. I suggest to return to the discussion when we support some format which doesn't require XML or ZIP extension.

By the way, we forgot two things.

  1. "ext-xmlwriter" should be optional.
  2. "ext-xsl" should be optional.

P.S.
As regards supporting DOC, I'm not sure it's a good idea. If somebody really needs it, lets discuss in a separate thread.

@Progi1984
Copy link
Member

@RomanSyroeshko @ivanlanin @bskrtich
After seen your answers and search in Composer doc, I give an another idea : use the suggest key in composer.json (https://github.com/composer/composer/blob/master/composer.json#L35).

So :

  • ext-xml & ext-zip in require
  • ext-xmlwriter & ext-xsl in suggest

What do you think about that ?

@ghost
Copy link

ghost commented Mar 14, 2014

Good idea. By the way, where did we get "ext-xml"? It seems PHP doesn't have such extension http:https://php.net/manual/en/extensions.membership.php.

@Progi1984
Copy link
Member

@RomanSyroeshko The package is php-xml. The doc is here : http:https://php.net/manual/en/xml.installation.php

@ivanlanin
Copy link
Contributor

Agree. Wrap it up and on to 0.8! :)

@ghost
Copy link

ghost commented Mar 14, 2014

@Progi1984, OK.

@ivanlanin, 0.7.2 first. :)

@Progi1984
Copy link
Member

@bskrtich Could you update your pull request, please ?

@Progi1984 Progi1984 mentioned this issue Mar 14, 2014
5 tasks
@ivanlanin
Copy link
Contributor

@bskrtich Wake up and update your pull request, dude. We're going to release 0.8 :)

@hskrtich
Copy link
Contributor Author

@ivanlanin Yes sir! lol I will get the push updated in the next few min.

@hskrtich
Copy link
Contributor Author

Ok a new push is up. I think i did every thing right

@ivanlanin
Copy link
Contributor

Thanks! 👍

@Progi1984
Copy link
Member

Fixed in develop branch.

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

Successfully merging a pull request may close this issue.

3 participants