Opened 12 months ago

Last modified 12 months ago

#3973 new defect

Link text useless in man page environment

Reported by: jidanni Owned by: grass-dev@…
Priority: trivial Milestone: 7.8.3
Component: Docs Version: unspecified
Keywords: g.manual g.html2man man URLs links Cc:
CPU: Unspecified Platform: Unspecified

Description

These links are great, but not in a plain text man page

$ man r.mapcalc|col -b|sed /^SOURCE/,$\!d
SOURCE CODE
       Available at: r.mapcalc source code (history)

       Main index | Raster index | Topics index | Keywords index | Graphical index | Full index

       © 2003-2019 GRASS Development Team, GRASS GIS 7.8.1 Reference Manual

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=944413 says it is upstream to blame.

Change History (6)

comment:1 Changed 12 months ago by neteler

Keywords: g.manual added
Milestone: 7.8.2

Yes, a long standing question (for us): how to add links to MAN manual pages?

(can be seen with g.manual -m <module>

Pointers welcome!

comment:2 Changed 12 months ago by neteler

Last edited 12 months ago by neteler (previous) (diff)

comment:3 Changed 12 months ago by jidanni

You would have to do something like

$ lynx -dump https://grass.osgeo.org/grass79/manuals/d.erase.html | tail -n 33
SOURCE CODE

   Available at: [12]d.erase source code ([13]history)
     _________________________________________________________________

   [14]Main index | [15]Display index | [16]Topics index | [17]Keywords
   index | [18]Graphical index | [19]Full index

   © 2003-2019 [20]GRASS Development Team, GRASS GIS 7.9.dev Reference
   Manual

References

   1. https://grass.osgeo.org/grass79/manuals/index.html
   2. https://grass.osgeo.org/grass79/manuals/display.html
   3. https://grass.osgeo.org/grass79/manuals/topic_graphics.html
   4. https://grass.osgeo.org/grass79/manuals/keywords.html#monitors
   5. https://grass.osgeo.org/grass79/manuals/d.erase.html#description
   6. https://grass.osgeo.org/grass79/manuals/d.erase.html#see-also
   7. https://grass.osgeo.org/grass79/manuals/d.erase.html#author
   8. https://grass.osgeo.org/grass79/manuals/d.mon.html
   9. https://grass.osgeo.org/grass79/manuals/d.redraw.html
  10. https://grass.osgeo.org/grass79/manuals/d.rast.html
  11. https://grass.osgeo.org/grass79/manuals/d.vect.html
  12. https://github.com/OSGeo/grass/tree/master/display/d.erase
  13. https://github.com/OSGeo/grass/commits/master/display/d.erase
  14. https://grass.osgeo.org/grass79/manuals/index.html
  15. https://grass.osgeo.org/grass79/manuals/display.html
  16. https://grass.osgeo.org/grass79/manuals/topics.html
  17. https://grass.osgeo.org/grass79/manuals/keywords.html
  18. https://grass.osgeo.org/grass79/manuals/graphical_index.html
  19. https://grass.osgeo.org/grass79/manuals/full_index.html
  20. http://grass.osgeo.org/

or better yet put each URL right next to the link text.

Anyway, you need to put the URLs right into the man page.

comment:4 Changed 12 months ago by wenzeslaus

Keywords: g.html2man man URLs links added

[12]d.erase source code and [13]history should be external URLs, but [14]Main index and [15]Display index are internal within documentation. Should they work more like in SEE ALSO?

comment:5 Changed 12 months ago by neteler

Milestone: 7.8.2

Ticket retargeted after milestone closed

comment:6 Changed 12 months ago by neteler

Milestone: 7.8.3
Note: See TracTickets for help on using tickets.