Project

General

Profile

Task #1850

Improve and enhance the online help

Added by Olivier Hallot almost 2 years ago. Updated about 1 month ago.

Status:
In Progress
Priority:
Normal
Target version:
-
Start date:
2016-03-08
Due date:
% Done:

0%

Estimated time:

Description

Improve and enhance the online help, including building and mentoring a community to work on it

Help files are written in xhp format (a xml format).

1) Tools for editing xhp files arlready exist although with some issues (HelpAuthoring.oxt in tools/ git repository).

2) Test page for pure xhp rendering: http://hc3.edx.srv.br
Help content for the site above: http://.hc3.edx.srv.br/tt.zip

3) see bug https://bugs.documentfoundation.org/show_bug.cgi?id=97629


Related issues

Related to Infrastructure - Feature #1303: editable help wikiNew

History

#1 Updated by Olivier Hallot over 1 year ago

  • Status changed from New to In Progress

Olivier Hallot wrote:

Improve and enhance the online help, including building and mentoring a community to work on it

Help files are written in xhp format (a xml format).

1) Tools for editing xhp files arlready exist although with some issues (HelpAuthoring.oxt in tools/ git repository).

2) Test page for pure xhp rendering: http://hc3.edx.srv.br
Help content for the site above: http://.hc3.edx.srv.br/tt.zip

3) see bug https://bugs.documentfoundation.org/show_bug.cgi?id=97629

Patch submitted

#2 Updated by Olivier Hallot over 1 year ago

Some patches submitted

Some patches from community chery-picked, tested and submitted to master.

Support for new contributor (Peter Toye, ML and IRC), Andrw Wetmore.

#3 Updated by Olivier Hallot over 1 year ago

VM173.documentfoundation.org made available in RAW state.

Issue with making xhp files to display because of a mime-type I don't know how to fix. If I can't get a support from #tdf-infra, I'll have to open a redmine ticket.

#4 Updated by Florian Effenberger over 1 year ago

Issue with making xhp files to display because of a mime-type I don't
know how to fix. If I can't get a support from #tdf-infra, I'll have to
open a redmine ticket.

Not sure if we run Apache or nginx on that box. If Apache, it could be
done with a .htaccess file, see e.g.
http://www.htaccess-guide.com/adding-mime-types/

For nginx, there's no such thing as .htaccess and things have to be done
manually in the configuration (but I lack insight on that)

#5 Updated by Florian Effenberger over 1 year ago

For nginx, this seems to be the solution (though I didn't try myself):
http://stackoverflow.com/questions/19629930/force-nginx-to-send-specific-content-type

#6 Updated by Olivier Hallot over 1 year ago

I throwed away nginx and installed apache2 and it fixed the issue by itself.

#7 Updated by Olivier Hallot over 1 year ago

Updated the on-line Helpcontent in XML, now with

+ An index extrated from all references of bookmarks in the xhp files, thru an XSLT
+ Index is now per module. Use Ctr+F in browser to find term in index.
+ Bookmark in browser bookmark system
+ More tweaks in the XLST transform.

Test in http://vm173.documentfoundation.org

#8 Updated by Florian Effenberger over 1 year ago

#9 Updated by Florian Effenberger over 1 year ago

  • Target version set to Q2/2016

#10 Updated by Florian Effenberger over 1 year ago

  • Target version changed from Q2/2016 to Q3/2016

I think you did some work on the online help in a test VM
Can you give a short status update on where we stand, what the next steps are and how important you consider this task?

Can we merge this with #1303 or is this different/something on top compared to this ticket?

#11 Updated by Olivier Hallot over 1 year ago

You're right, I made a confusion between the wiki help (work from Kendy) and VM173, which I lead.

Currently the VM works very well. I use it allways for checking HC2 consistency and keep updated with the latest developments of the HC2

It has been put as a resource for translators, whith a direct connection between Pootle and VM173.

To push this solution further need modifications and new approach for help content that is under discussion.

I have installed an text editor to allow direct XML editing in the help files, and have a immedaite rendering. Works perfectly.

Nevertheless the edited contents cannot be merged back to git because the current files displayed have transformations that are not allowed yet to be part of the XHP schema.

#12 Updated by Olivier Hallot about 1 year ago

Some contacts with LionGold on vm172, ticket#1856.

#13 Updated by Florian Effenberger about 1 year ago

  • Target version changed from Q3/2016 to Q4/2016

#14 Updated by Florian Effenberger 11 months ago

  • Target version changed from Q4/2016 to Q1/2017

#15 Updated by Florian Effenberger 8 months ago

  • Target version changed from Q1/2017 to Qlater

Can you provide a status update on this?
IIRC it was part of the planned tender that you now want to put into separate slices
Note this ticket is public, so any tender-ish items, please e-mail me directly :-)

#16 Updated by Olivier Hallot 8 months ago

  • vm173.documentfondation.org working satisfactorily and good platform for testing new HC changes and evolving to HC3 (new help system in browser).
  • Still waiting for pootle fix to move many images and changes in HC tags without affecting translators jobs.
  • Improvements on HC3 on the way.

#17 Updated by Florian Effenberger 6 months ago

  • Target version deleted (Qlater)

#18 Updated by Florian Effenberger about 1 month ago

I think this can be merged or linked with #2394
Mike, can you have a look at the tasks and add as you see fit?

Also available in: Atom PDF