Have a table with differences betwen Writers' features about phpword HOT 15 CLOSED

A starting documentation is present here : http://phpword.readthedocs.org/en/develop/index.html

from phpword.

@ivanlanin Could you add your table in docs ?

from phpword.

Wow. RTD changes our manual almost instantly :)

Btw, I use pandoc since I'm too lazy to write rst myself.

from phpword.

@Progi1984 Checkout the updated README.md and rst files :)

from phpword.

No problem for using Pandoc ;)

For the table with differences, I thought to this : https://github.com/PHPOffice/PHPExcel/blob/master/Documentation/Functionality%20Cross-Reference.xls (without getters & setters)

Furthermore, I think the file Readme.md must not contain the documentation but must be a reference where to find documentation, install, and so on like PHPExcel. Because the documentation is located to two places and we risk to forget updating one.

from phpword.

Ah, I see. Ok. I don't think we could create something like that using markup. It's too complicated. We better use Google Spreadsheet or use Excel, like PHPExcel, and put it in the docs folder. I prefer the first approach since we can keep our source code clean from binaries.

Regarding duplicate docs, I agree. So we keep the README simple and focus on the rst?

from phpword.

I have edited the documentation for outputting what I thought : http://phpword.readthedocs.org/en/develop/intro.html#file-formats.
It's not Markdown, it's reStructuredText (.rst).

For a simple ReadMe, and a focus on the RST, I agree.

from phpword.

Look much better. Got it. I'll migrate the README.md contents to rst and will continue the documentation there.

Can we close this issue? :)

from phpword.

I must redesign the second table and add some features.
I will do this week-end.

from phpword.

While you're on it, could you also check the PDF generated from our docs? There is no TOC, no index page at the back, and the first few pages of PDF looks empty. What should we do? Thanks.

from phpword.

I just improved tables with features support.
https://phpword.readthedocs.org/en/develop/intro.html#file-formats

I look at the PDF ;)

from phpword.

Ah, much better now :) But why there's still no TOC? Is there any special setup we have put? RTD seems can't render the checkmarks on the feature table, either.

from phpword.

For the TOC, it seems that it's a bug : readthedocs/readthedocs.org#665

from phpword.

The workaround dc28fd6 seems to work :)

from phpword.

Yep, Perfect, I close it :)

from phpword.