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

Have a table with differences betwen Writers' features #82

Closed
Progi1984 opened this issue Mar 3, 2014 · 15 comments
Closed

Have a table with differences betwen Writers' features #82

Progi1984 opened this issue Mar 3, 2014 · 15 comments
Assignees
Milestone

Comments

@Progi1984
Copy link
Member

No description provided.

@Progi1984 Progi1984 added this to the 0.7.2 milestone Mar 3, 2014
@Progi1984 Progi1984 mentioned this issue Mar 3, 2014
12 tasks
@Progi1984
Copy link
Member Author

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

ivanlanin added a commit to ivanlanin/PHPWord that referenced this issue Mar 19, 2014
@Progi1984
Copy link
Member Author

@ivanlanin Could you add your table in docs ?

@ivanlanin
Copy link
Contributor

Wow. RTD changes our manual almost instantly :)

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

@ivanlanin
Copy link
Contributor

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

@Progi1984
Copy link
Member Author

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.

@ivanlanin
Copy link
Contributor

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?

@Progi1984
Copy link
Member Author

I have edited the documentation for outputting what I thought : http:https://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.

@ivanlanin
Copy link
Contributor

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? :)

@Progi1984
Copy link
Member Author

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

@ivanlanin
Copy link
Contributor

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.

Progi1984 added a commit that referenced this issue Mar 22, 2014
@Progi1984
Copy link
Member Author

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

I look at the PDF ;)

@ivanlanin
Copy link
Contributor

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.

@Progi1984
Copy link
Member Author

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

@ivanlanin
Copy link
Contributor

The workaround dc28fd6 seems to work :)

@Progi1984
Copy link
Member Author

Yep, Perfect, I close it :)

@Progi1984 Progi1984 self-assigned this Mar 22, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants