Bug 403066 - [Bidi] Update documentation for bidi APIs and command line options
Summary: [Bidi] Update documentation for bidi APIs and command line options
Status: CLOSED WONTFIX
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Doc (show other bugs)
Version: 4.3   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Markus Keller CLA
QA Contact:
URL:
Whiteboard: stalebug
Keywords: Documentation, helpwanted
Depends on: 307307 380397 383185
Blocks:
  Show dependency tree
 
Reported: 2013-03-12 11:44 EDT by Markus Keller CLA
Modified: 2019-10-04 15:50 EDT (History)
6 users (show)

See Also:


Attachments
Patch on bidi.html and runtime-options.html (10.94 KB, patch)
2013-05-27 10:57 EDT, Lina Kemmel CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Markus Keller CLA 2013-03-12 11:44:30 EDT
Update documentation for bidi APIs and command line options

See bug 383185, bug 307307, and bug 380397.
Comment 1 Markus Keller CLA 2013-03-12 11:46:21 EDT
Patches for git://git.eclipse.org/gitroot/platform/eclipse.platform.common.git welcome ;-)
Comment 2 Tomer Mahlin CLA 2013-04-23 13:22:05 EDT
Hi Markus,  can you please let us know where exactly can we describe the new command line options and API ? I presume the request (and need) is not in Java Doc like documentation (which is already available since comments were added to the code), but in a general more descriptive and end user focused article.
What is the right place for such an article ? 
I can provide the content in this bug but I am sure there is a better place to publish it. 

Thanks a lot in advance for your guidance.
Comment 3 Markus Keller CLA 2013-04-23 13:58:49 EDT
We should update these documents:
- org.eclipse.platform.doc.isv/reference/misc/bidi.html
- org.eclipse.platform.doc.isv/guide/st_text_types.htm
- org.eclipse.platform.doc.isv/reference/misc/runtime-options.html
=> Add "-bidi (org.eclipse.ui.workbench)" to the "Others" section. "-dir" should also have been added there, but instead, the information ended up only here: http://todcreaseyeclipse.blogspot.ch/2007/03/bidirectional-support-faq.html
Comment 4 Lina Kemmel CLA 2013-05-27 10:57:00 EDT
Created attachment 231557 [details]
Patch on bidi.html and runtime-options.html

Updates for:
- org.eclipse.platform.doc.isv/reference/misc/bidi.html
- org.eclipse.platform.doc.isv/reference/misc/runtime-options.html
Comment 5 Markus Keller CLA 2013-05-29 09:52:22 EDT
Fixed typos (nlExtentions) and some formatting, and released with
http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=20d0261dbb01b159755935a17f239f2c20fd3822

Filed bug 409391 for strange arrow key behavior in one of the examples.
Comment 6 Markus Keller CLA 2013-05-31 10:50:49 EDT
Remaining issue is that org.eclipse.platform.doc.isv/guide/st_text_types.htm
contains STTs that have been removed/renamed, and the order is not the same as everywhere else (alphabetic).

Some of the removed STTs could be presented as examples for how the framework can be extended by clients.
Comment 7 Markus Keller CLA 2013-06-05 20:07:09 EDT
Reordered the STTs in st_text_types.htm and removed unsupported ones: http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=4cd40cedd7c8f1a3635af9bb18bd9298ec2d9852

Moving to 4.4. to add descriptions for missing STTs and revive the dropped ones as examples for how to contribute new types.
Comment 8 Eclipse Genie CLA 2019-10-04 15:50:50 EDT
This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet.

If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant.

--
The automated Eclipse Genie.