oracle/opengrok

Can opengrok provide a code snippet function

Open

#3015 opened on Jan 8, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Java (4,060 stars) (747 forks)batch import
UIenhancementhelp wanted

Description

Is your feature request related to a problem? Please describe. I want to add code snippet in Wiki and Confluence page, but it always add a whole file.

like: url is https://jcat-opengrok/opengrok/snippet/p1/path/Cat.java#10-20 the output only include lines from 10 to 20. No other things. no head.

Describe the solution you'd like add a function: snippet.

Describe alternatives you've considered https://jcat-opengrok/opengrok/xref/p1/path/Cat.java#10-20

Additional context Used in the other tools. or use in Html file, for example in iFrame.

Contributor guide

Tech stack
java
Domain
full stack
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
JavaOpenGrok architectureServlet programming
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the existing xref servlet (e.g., XrefServlet.java) in the OpenGrok codebase to understand how it handles file display and line numbers. Look for any existing support for line range snippets. Then propose adding a new endpoint or modifying the existing one to return only the specified lines, ensuring it works with the existing URL pattern and supports iframe embedding. Review any linked issues or pull requests for prior attempts.