Enhancement #2627

RST format for help files

Added by Davide Principi almost 6 years ago. Updated almost 6 years ago.

Status:CLOSEDStart date:
Priority:NormalDue date:
Assignee:-% Done:

100%

Category:nethserver-devtools
Target version:v6.5-beta3
Resolution: NEEDINFO:No

Description

Convert RST files to HTML during RPM builds


Related issues

Related to NethServer 6 - Task #1780: Update all inline help documentation CLOSED
Related to NethServer 6 - Enhancement #2640: Help templates in RST format CLOSED

Associated revisions

Revision cc0bc63e
Added by Davide Principi almost 6 years ago

Grab help contents from the first DIV in BODY tag. Refs #2627

Removed all obsolte parsing functions that open tooltips.

Revision a9736265
Added by Davide Principi almost 6 years ago

Underline text in DT tags. Refs #2627

The underline style is no more applied automatically.

Revision 62084397
Added by Davide Principi almost 6 years ago

Converted online help to RST format. Refs #2627

Revision e2ab753e
Added by Davide Principi almost 6 years ago

Converted online help to RST format. Refs #2627

Revision 04697974
Added by Davide Principi almost 6 years ago

Converted online help to RST format. Refs #2627

Revision e5b863b5
Added by Davide Principi almost 6 years ago

Fixed CSS margin for help documents. Refs #2627

Revision ae029078
Added by Davide Principi almost 6 years ago

English help document (by Google Translate). Refs #2627

Revision 9ccf9c00
Added by Davide Principi almost 6 years ago

English help document (by Google Translate). Refs #2627

Revision a5695b26
Added by Davide Principi almost 6 years ago

English help document (by Google Translate). Refs #2627

Revision 8707cc74
Added by Davide Principi almost 6 years ago

Help/Common: read language from Request object. Refs #2627

Revision 5d8a0a7f
Added by Giacomo Sanchietti almost 6 years ago

Revision of english help document. Refs #2627

Revision bd7a4da6
Added by Giacomo Sanchietti almost 6 years ago

Revision of english help document. Refs #2627

Revision 38b7c14f
Added by Davide Principi almost 6 years ago

Moved DHCP help in nethserver-dnsmasq package. Refs #2627

Revision e68cbc31
Added by Davide Principi almost 6 years ago

Added help documents to be included by Hosts module. Refs #2627

History

#1 Updated by Davide Principi almost 6 years ago

  • Tracker changed from Feature to Enhancement

#2 Updated by Giacomo Sanchietti almost 6 years ago

  • Status changed from TRIAGED to ON_DEV
  • % Done changed from 20 to 30

#3 Updated by Giacomo Sanchietti almost 6 years ago

  • Status changed from ON_DEV to TRIAGED
  • % Done changed from 30 to 20

#4 Updated by Davide Principi almost 6 years ago

  • Status changed from TRIAGED to ON_DEV
  • Assignee set to Davide Principi
  • % Done changed from 20 to 30

#5 Updated by Davide Principi almost 6 years ago

  • Status changed from ON_DEV to MODIFIED
  • Assignee deleted (Davide Principi)
  • % Done changed from 30 to 60

Added a %{makedocs} RPM macro to be appended to the %build section in .spec files.

Test case 1

  • Add %{makedocs} macro to a package spec file
  • Add some .rst files
  • Rebuild the package

The output package must contain an .html output file created from the corresponding .rst file by rst2html command.

Test case 2

nethgui - fixed the language of help documents to reflect URL setting

  1. Open Help from User module with it lang
  2. Change URL lang to en
  3. Open Help again

#6 Updated by Davide Principi almost 6 years ago

  • Status changed from MODIFIED to ON_QA
  • % Done changed from 60 to 70

In nethserver-testing:
nethserver-devtools-1.1.0-5.0git578a72fb.ns6.noarch.rpm
nethserver-nethgui-1.3.0-13.0git8707cc74.ns6.noarch.rpm

#7 Updated by Davide Principi almost 6 years ago

  • Status changed from ON_QA to TRIAGED
  • % Done changed from 70 to 20
TODOs

#8 Updated by Davide Principi almost 6 years ago

  • Status changed from TRIAGED to ON_DEV
  • % Done changed from 20 to 30

#9 Updated by Davide Principi almost 6 years ago

  • Status changed from ON_DEV to MODIFIED
  • % Done changed from 30 to 60

Not really modified.

Help templates in RST format moved to related issue, #2640

Proceed with QA

#10 Updated by Davide Principi almost 6 years ago

  • Status changed from MODIFIED to ON_QA
  • % Done changed from 60 to 70

See above

Before closing this issue, remeber to update documentation Creating help pages.

#11 Updated by Giacomo Sanchietti almost 6 years ago

  • Assignee set to Giacomo Sanchietti

#12 Updated by Giacomo Sanchietti almost 6 years ago

  • Status changed from ON_QA to VERIFIED
  • Assignee deleted (Giacomo Sanchietti)
  • % Done changed from 70 to 90

Help files are correctly displayed in Italian and English.
Also documents with plugin behavior work ok.

Marking as VERIFIED.

#13 Updated by Davide Principi almost 6 years ago

  • Status changed from VERIFIED to CLOSED
  • % Done changed from 90 to 100

Released in nethserver/6.5/base repository.

Also available in: Atom PDF