1263925 - SeaMonkey Tools and Development.xhtml: Add link to Help for new Firefox Devtools

Status: RESOLVED FIXED

(SeaMonkey :: Help Documentation, defect)

Description

[Rainer Bielefeld]

With fix for "Bug 1223341 - Add the Firefox Devtools to the SeaMonkey UI" we need some Help contents for that.

Could be done as a simple link to <https://developer.mozilla.org/ca/docs/Tools> (is evne localized, but I don't know how good that matches with SM-FF-DevTools) or an own ff_devtools.xhtml in SM Help.

Comment 1

[Philip Chee]

Firefox Developer Tools is large and contains multitudes. Also it's a rapidly moving target. I recommend just a link to <https://developer.mozilla.org/docs/Tools>

Note: if you leave out the locale in the link, DevMo will do some browser sniffing and guess your locale:
https://developer.mozilla.org/en-US/docs/Tools => https://developer.mozilla.org/docs/Tools

Comment 2

[Rainer Bielefeld]

(In reply to Philip Chee from comment #1)
> rapidly moving target. I recommend just a link to
> <https://developer.mozilla.org/docs/Tools>

Yes, we should not invest too much work, it's so easy to reach the contents with a link to the central start point of the DevTools documentation.

Comment 3

[Rainer Bielefeld]

This one blocks "Bug 1268037 (meta) Help cleanup 2016"

Comment 4

[Rainer Bielefeld]

NEW due to <https://blog.seamonkey-project.org/2015/11/25/my-unconfirmed-bug-reports/>; I see new DevTools integrated in English SeaMonkey (unofficial by frg) 2.47a1  (NT 6.1; Win64; x64; rv:50.0)  Gecko/20100101 Firefox/50.0 Build 20160628114904  (Default Classic Theme)  on German WIN7 64bit

Test suggestion: see attachment!

@Isaac Schemm:
you did a similar fix in "Bug 1224231" - can you help here, too?

Comment 5

[Rainer Bielefeld]

Attachment: developer tools help with text suggestion

not a patch

Comment 6

[Isaac Schemm]

How about this?

"Developer Tools: SeaMonkey includes the same developer tools as Firefox, including a page inspector, console, and a JavaScript debugger.

Online resources:

    Firefox Developer Tools (developer.mozilla.org)"

Comment 7

[Rainer Bielefeld]

I prefer go keep the different hyperlinks, I even think we should find chapters for each TAB or whatever on developer.mozilla.org. I believe Error Console will vanish soon (Bug 1282286 - Port changes from Bug 1278368 to Seamonkey. Error Console has been replaced by Browser Console), and afterwards also not-develpers will have to use new Tools.

Comment 8

[Isaac Schemm]

Let me write down the menu options so that I remember:

* Error Console - already in Help, might be removed
* Validate This Page - goes to validator.w3.org/...
* DOM Inspector - already in Help

* Toggle Tools (shows last used tool)
* Inspector
* Web Console
* Debugger
* Style Editor
* Performance
* Network

* Developer Toolbar
* WebIDE
* Browser Console
* Responsive Design View - does this work in current comm-central?
* Eyedropper - does this work in current comm-central?
* Scratchpad
* Allow Remote Debugging (if enabled, adds option "Connect...")

* Get More Tools

Since this bug is only about DevTools, we should cover "Toggle Tools" through "Allow Remote Debugging".
If there's anything that is still broken in current trunk builds, I'd suggest now adding anything to Help about it for the time being.

Comment 9

[Isaac Schemm]

Eyedropper works in akalla's June 19 aurora build.
Responsive Design View does not (bug 1284504).

Comment 10

[Isaac Schemm]

Attachment: developer_tools.xhtml

Here's a version with a bullet point for each of the new options. I added one for Responsive Design as well even though it's not currently working.

The SeaMonkey developers might end up keeping Error Console if they can move the code over to the comm-central tree.

Comment 11

[Rainer Bielefeld]

Attachment 2016 [details]-07-05 17:14 CEST, Isaac Schemm:
Design suggestion looks fine for me.

Comment 12

[Isaac Schemm]

Attachment: new-developer-tools-help.patch

As long as I'm at my computer I might as well make a patch.
I assigned the review to stefanh since he's been around lately, but anyone else is welcome to make suggestions too.

Comment 13

[Stefan [:stefanh]]

Comment on attachment 8768595 [details] [diff] [review]
new-developer-tools-help.patch

Sorry for the late response (I'm swamped atm).

This patch is actually not complete, since you haven't added any entry to the .rdf files (like suite-toc.rdf).

Also, I'm not sure if you should add all these links - I think it would be difficult to maintain (who would notice and update help if someone edits the links?). I think it would be better to do something in line with comment #1.

Comment 14

[Isaac Schemm]

Do you know if there's a way to link to a particular version of the Firefox documentation? I know devtools can change over time. If not, I think that's OK.

Do you think this text is sufficient?

Developer Tools: &brandShortName; includes a set of developer tools that can be docked to the bottom of the browser or used in a separate window. The <strong>Toggle Tools</strong> command in the Web Development menu can be used to open and close the Developer Tools.

The Developer Tools are shared with Firefox. To learn more about the Developer Tools, visit the __Firefox Developer Tools site__. (goes to https://developer.mozilla.org/docs/Tools)

Comment 15

[Isaac Schemm]

Attachment: 1263925-new-devtools-help-v2.patch

Here's a version that uses the text from my previous comment.

Comment 16

[Ian Neal]

Comment on attachment 8775252 [details] [diff] [review]
1263925-new-devtools-help-v2.patch

>+++ b/suite/locales/en-US/chrome/common/help/developer_tools.xhtml

>+  <li id="devtools">
>+    <strong>Developer Tools</strong>: &brandShortName; includes a set of
>+    developer tools that can be docked to the bottom of the browser or used in
...to the bottom of a browser window or used in
>+    a separate window. The <strong>Toggle Tools</strong> command in the Web
>+    Development menu can be used to open and close the Developer Tools.

>+++ b/suite/locales/en-US/chrome/common/help/suite-toc.rdf

>+        <rdf:li><rdf:Description ID="tools-devtools" nc:name="Dveloper Tools" nc:link="developer_tools.xhtml#devtools"/> </rdf:li>
Nit: typo should be "Developer Tools" not "Dveloper Tools"

r/a=me with those fixed.

Comment 17

[Isaac Schemm]

Attachment: 1263925-new-devtools-help-v3.patch

Comment 18

[Ian Neal]

Comment on attachment 8785682 [details] [diff] [review]
1263925-new-devtools-help-v3.patch

>+  <li id="devtools">
>+    <strong>Developer Tools</strong>: &brandShortName; includes a set of
>+    developer tools that can be docked to the bottom of a browser window or
>+	used in a separate window. The <strong>Toggle Tools</strong> command in
>+	the Web Development menu can be used to open and close the Developer Tools.
Nit: Indentation is incorrect for second line of paragraph.

r/a=me with that fixed.

Comment 19

[Isaac Schemm]

Attachment: 1263925-new-devtools-help-v4.patch

Comment 20

[Ian Neal]

Comment on attachment 8785684 [details] [diff] [review]
1263925-new-devtools-help-v4.patch

Glad you understood what I meant r/a=me

Comment 21

[rsx11m]

http://hg.mozilla.org/comm-central/rev/f465cb3cf104