[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [pdt-dev] PDT Help

Hi,

now everything should be ok.

Documentation is still outdated. I planned to fix this while RC phase.

--
Dawid PakuÅa 
+48 795 996 064

On 13 Jan 2015 at 14:22:35, MichaÅ NiewrzaÅ (michal.n@xxxxxxxx) wrote:

Thanks. Now PDT is compiling and help is working, but lots of pages got exception like this or similar:
org.xml.sax.SAXParseException; lineNumber: 9; columnNumber: 20; The element type "tr" must be terminated by the matching end-tag "</tr>".
        at com.sun.org.apache.xerces.internal.parsers.DOMParser.parse(DOMParser.java:257)
I didn't mark all of them in gerrit because too much of links are broken. I just clicked through whole PDT User Guide tree.
And I also noticed that we need to add PHP 5.6 in plugins/org.eclipse.php.help/docs/source/016-concepts/008-php_support.md.
Michal

On Tue, Jan 13, 2015 at 2:00 PM, Dawid PakuÅa <zulus@xxxxxxxxx> wrote:
Run make install on help plugin. I have to register external build runner for help project.

--
Dawid PakuÅa 

On 13 Jan 2015 at 13:59:16, MichaÅ NiewrzaÅ (michal.n@xxxxxxxx) wrote:

I fetched patch from gerrit and I have problem with deleted IPHPHelpContextIds. I missed something?

Michal

On Tue, Jan 13, 2015 at 1:52 PM, Dawid PakuÅa <zulus@xxxxxxxxx> wrote:
Hi,

I just rebased and fixed couple issues. 

Can we release it as part of PDT 3.4.0 ?

--
Dawid PakuÅa 

On 13 Oct 2014 at 02:13:01, Dawid PakuÅa (zulus@xxxxxxxxx) wrote:

Hi,

here is an initial patch [1]

1. I converted html to markdown (some issues have to be fixed manually)
2. Pages that was not connected to anything, was removed. This was documentation for Zend Studio features (like Semantic Analysis). After that documentation size is 2.2MB !!!
3. Whole documentation is no longer flat (see plugins/org.eclipse.php.help/docs/source)
4. Based on this structure, maven will generate IPHPContextsIds class, helpContexts.xml and toc.xml
5. Everything is done while maven clean install via ant and _javascript_ (see plugins/org.eclipse.php.help/docs/source/build.xml and plugins/org.eclipse.php.help/docs/source/compile.js)
6. CSS is very similar to Github Atom markdown preview plugin. I hope you like it ;)

Known issues:

1. Mylyn wikitext sometimes generate mailformed html code [2]
2. Some pages have wrong markdown code
3. We are using mylyn snapshots, due this issue [3]

Maybe someone know better EPL friendly MarkdownToHTML converter? As an alternative, I could write it in _javascript_ :/

[1] - https://git.eclipse.org/r/#/c/34783/
[2] - https://bugs.eclipse.org/bugs/show_bug.cgi?id=446788
[3] - https://bugs.eclipse.org/bugs/show_bug.cgi?id=445707

--
Dawid PakuÅa

On Mon, Sep 29, 2014 at 6:01 PM, Kaloyan Raev <kaloyan.r@xxxxxxxx> wrote:
I am used to both Markdown and Wikitext.

Kaloyan

On Mon, Sep 29, 2014 at 6:11 PM, Dawid PakuÅa <zulus@xxxxxxxxx> wrote:
Hi,

others agree to option 2?

What format you prefer? Markdown/Textile/Wikitext/Creole?
My favourite is a markdown [1], very popular now. Wikitext have builtin editor with preview since last year.
 
[1] - http://daringfireball.net/projects/markdown/syntax

--
Dawid PakuÅa 

On 29 wrzeÅnia 2014 at 09:24:36, Kaloyan Raev (kaloyan.r@xxxxxxxx) wrote:

Hi Dawid, 

I completely agree that the PDT Help must be improved in the direction you suggest.

Let's try option 2 as you suggest. I like the idea of having source and documentation together. We can build the habit of enforcing documentation updates when reviewing patches in Gerrit.

Greetings,
Kaloyan

On Sat, Sep 27, 2014 at 2:47 PM, Dawid PakuÅa <zulus@xxxxxxxxx> wrote:
Hi team,

At begin, I was officially approved as new project lead. Thank you for a trust!

From my side, I want introduce process of incremental cleaning up code and documentation. At first, it could be PDT User Manual.

In past, we receive initial documentation from Zend Company (thank you for that). Unfortunately this documentation is now outdated and unmaintainable. Besides itâs also available in online mode only [1]. 

Would be good to convert it into more developer familiar format, update and move to org.eclipse.php.help plugin again. This also allow us to participate in eclipse info center [2]. Of course good documentation have also many other advantages.

I have serveral propositions how we can do that:

1. Convert to eclipse wiki page, and compile to eclipse help on demand or while mvn clean install. Like Mylyn and Egit [3]
 advantages:
  * help can be updated by our user
  * webinterface
 disadvantages:
  * we havenât full control on help
  * after each ui change, we have to remember about help update. Probably everybody forgot

2. Convert to creole wikitext / textile and put source directly inside help plugin repo. Like Xtext [3][4]
 advantages:
  * we can update help and source code in one patch
  * full control on help
  * gerrit :D
 disadvantages:
  * users need CLA signed to send contribution

3. Only cleanup html code and put to help plugin
 advantages:
  * probably everybody know HTML
  * same advantages as point 2
 disadvantages:
  * more boilerplate code, probably unreadable without html editor + preview
  * same as point 2

4. Ignore me ;)

My favourite is point 2. Our format can be Markdown, WikiText, Creole, Textile.

[1] - https://bugs.eclipse.org/bugs/show_bug.cgi?id=369635

--
Dawid PakuÅa 

_______________________________________________
pdt-dev mailing list
pdt-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/pdt-dev

_______________________________________________
pdt-dev mailing list
pdt-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/pdt-dev

_______________________________________________
pdt-dev mailing list
pdt-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/pdt-dev


_______________________________________________
pdt-dev mailing list
pdt-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/pdt-dev



--


_______________________________________________
pdt-dev mailing list
pdt-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/pdt-dev

_______________________________________________
pdt-dev mailing list
pdt-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/pdt-dev

_______________________________________________
pdt-dev mailing list
pdt-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/pdt-dev

_______________________________________________
pdt-dev mailing list
pdt-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/pdt-dev