188775 - Doctor should offer link to download plain text version of diff

Status: RESOLVED FIXED

(Webtools Graveyard :: Doctor, defect)

Description

[Gervase Markham [:gerv]]

Unless I'm missing something, if someone wants to attach a diff to a Bugzilla
bug, they have to cut and paste the text out of the middle of the preview page.
It would be great to have a link which served up a text/plain file of just the
changes.

Gerv

Comment 1

[Reed Loden [:reed]]

This is still greatly wanted. It's annoying to copy/paste doctor's output into an editor, save the file, and then attach it to a bug.

Comment 2

[Frédéric Buclin]

This should be easy to do. :)

Comment 3

[Frédéric Buclin]

Attachment: patch, v1

The "Save" tab now allows you to save your patch either on the CVS server or on your local harddrive.

Comment 4

[Myk Melez [:myk] [@mykmelez]]

Comment on attachment 220587 [details] [diff] [review]
patch, v1

The code here looks good, it's just the UI that could use some work.  Let me think about it a bit.

Comment 5

[Myk Melez [:myk] [@mykmelez]]

Comment on attachment 220587 [details] [diff] [review]
patch, v1

My current thinking is to change the download link to accommodate downloading of diffs, i.e.:

download _file_ _diff_

where _file_ and _diff_ are links to download the file and the diff, respectively.

(On a related note, it would make sense to the label of the "Save" tab to "Save Changes" and the "Commit" button to "Commit Changes to Repository".)

Comment 6

[Frédéric Buclin]

(In reply to comment #5)
> My current thinking is to change the download link to accommodate downloading
> of diffs, i.e.:
> 
> download _file_ _diff_

I disagree. On a 1024x768 screen, the "upload" field most of the time "jumps" to a new line because there is already a lot of thing displayed in this line ("navbar" as you said on IRC). So the "keep everything on one line" comment would fail here. Moreover, having URLs in titles is not very nice, from a UI point of view, IMHO.

We already have two links, one to view the original page being edited, and a second one to download the original file. Adding a third one to download the diff would be pretty confusing, especially without explanations. And I think link titles are not obvious enough to use them as a way to indicate which link is which.

> (On a related note, it would make sense to the label of the "Save" tab to "Save
> Changes" and the "Commit" button to "Commit Changes to Repository".)

I agree. And "Save Changes" is really the place where a diff should go, as you will "save changes" to your local computer.

Comment 7

[Myk Melez [:myk] [@mykmelez]]

> I disagree. On a 1024x768 screen, the "upload" field most of the time "jumps"
> to a new line because there is already a lot of thing displayed in this line
> ("navbar" as you said on IRC). So the "keep everything on one line" comment
> would fail here.

Hmm, you're right, that's problematic.  Probably the long-term fix is a better, more compact toolbar, but in the meantime it's probably easier to add this to the Save Changes tab.


> "Save Changes" is really the place where a diff should go, as you
> will "save changes" to your local computer.

Ok, let's do this: change the label of the "Save" tab to "Save Changes" and add the following line above the form in the tab:

[Download Diff] or commit changes to the repository:

(where [Download Diff] is the link to download the diff)

Comment 8

[Frédéric Buclin]

Attachment: patch, v2

"Download Diff" must be a button in order to catch data from the form.

Comment 9

[Myk Melez [:myk] [@mykmelez]]

Comment on attachment 221517 [details] [diff] [review]
patch, v2

>+          <button type="submit" name="action" value="download-diff">Download Diff</button>
>+          or commit changes to the repository:<p>

Paragraph tags should be used as containers, i.e.:

<p>
  <button type="submit" name="action" value="download-diff">Download Diff</button>
  or commit changes to the repository:
</p>

Otherwise this looks good.  Fix that upon checkin, and r=myk

Comment 10

[Frédéric Buclin]

Checking in doctor.cgi;
/cvsroot/mozilla/webtools/doctor/doctor.cgi,v  <--  doctor.cgi
new revision: 1.25; previous revision: 1.24
done
Checking in Doctor/File.pm;
/cvsroot/mozilla/webtools/doctor/Doctor/File.pm,v  <--  File.pm
new revision: 1.10; previous revision: 1.9
done
Checking in templates/edit.tmpl;
/cvsroot/mozilla/webtools/doctor/templates/edit.tmpl,v  <--  edit.tmpl
new revision: 1.17; previous revision: 1.16
done