Closed Bug 282783 Opened 20 years ago Closed 20 years ago

Remove tabs from help files

Categories

(Documentation Graveyard :: Help Viewer, defect)

Product:
Documentation Graveyard
Component:
Help Viewer
Type:
defect
Priority:
Not set
Severity:
normal

Tracking

(Not tracked)

Status:
RESOLVED FIXED

People

(Reporter: iannbugzilla, Unassigned)

References

Details

Attachments

(2 files, 1 obsolete file)

Patch for help_help.xhtml (Checked in)
7.63 KB, patch
iannbugzilla
: review+
Details | Diff | Splinter Review
Fixed nits, uniform <title>s and <link>s, some more indentation here and there...
132.77 KB, patch
iannbugzilla
: review-
Details | Diff | Splinter Review 
Neil has just pointed out that
http://lxr.mozilla.org/mozilla/source/extensions/help/resources/locale/en-US/help_help.xhtml
is full of tabs, possibly other help files still have some too.
NeilAlmostZZZ	{#mozilla} IanN: rs=me to fix them
Attachment #174748 - Flags: review+
Comment on attachment 174748 [details] [diff] [review]
Patch for help_help.xhtml
(Checked in)

Checking in help_help.xhtml;
/cvsroot/mozilla/extensions/help/resources/locale/en-US/help_help.xhtml,v  <-- 
help_help.xhtml
new revision: 1.21; previous revision: 1.20
done
Attachment #174748 - Attachment description: Patch for help_help.xhtml → Patch for help_help.xhtml (Checked in)
>possibly other help files still have some too.

I see at least two more files: welcome_help & composer_help. But there could be
more...

        Attachment #174791 -
        Flags: review?(bugzilla)

    
    

    
  
Comment on attachment 174791 [details] [diff] [review]
All of the rest, in one shot. No string changes.

>Index: en-US/cert_dialog_help.xhtml
>===================================================================
> <html xmlns="http://www.w3.org/1999/xhtml">
> <head>
>-	<title>Certificate Information and Decisions</title>
>-	<link rel="stylesheet" type="text/css" href="chrome://help/locale/helpFileLayout.css"/>
>+<title>Certificate Information and Decisions</title>
>+<link rel="stylesheet" type="text/css" href="chrome://help/locale/helpFileLayout.css"/>
> </head>
<title> and <link> are usually indented by two spaces.

>@@ -88,57 +88,59 @@
>         an online status responder that uses the Online Certificate Status Protocol
>         (OCSP) to check the validity of certificates. For more information about
>         OCSP, see <a href="validation_help.xhtml">Validation Settings</a>.</li>
>       <li><strong>SSL Certificate Authority:</strong> Certificate used to identify
>         a certificate authority&mdash;that is, a service that issues certificates for
>         use as identification over computer networks.</li>
>     </ul>
>     </li>
</il> needs bringing back two spaces which makes the rest of your indentations
wrong below.

>-	<li><strong>Issued To:</strong> Summarizes the following information about the
>-	  certificate:
>+    <li><strong>Issued To:</strong> Summarizes the following information about the
>+      certificate:
>       <ul>
>-	    <li><strong>Common Name:</strong> The name of the person or other entity that
>-	      the certificate identifies.</li>
>+        <li><strong>Common Name:</strong> The name of the person or other entity that
>+          the certificate identifies.</li>
>         <li><strong>Organization:</strong> The name of the organization to which the
>           entity belongs (such as the name of a company).</li>
>         <li><strong>Organizational Unit:</strong> The name of the organizational unit
>           to which the entity belongs (such as Accounting Department).</li>
>         <li><strong>Serial Number:</strong> The certificate&apos;s serial number.</li>
>       </ul>
>-	</li>
>-	<li><strong>Issued By:</strong> Summarizes information (similar to that provided
>-	  under <q>Issued To</q>; see above) about the certificate authority (CA)
>-	  that issued the  certificate.</li>
>-	<li><strong>Validity:</strong> Indicates the period during which the certificate
>-	  is valid.</li>
>-	<li><strong>Fingerprints:</strong> Lists the certificate&apos;s fingerprints. A
>-	  fingerprint is a unique number produced by applying a mathematical function to
>-	  the certificate contents. A certificate&apos;s fingerprint can be used to verify 
>-   that the certificate has not been tampered with.</li>
>+    </li>
>+    <li><strong>Issued By:</strong> Summarizes information (similar to that provided
>+      under <q>Issued To</q>; see above) about the certificate authority (CA)
>+      that issued the  certificate.</li>
>+    <li><strong>Validity:</strong> Indicates the period during which the certificate
>+      is valid.</li>
>+    <li><strong>Fingerprints:</strong> Lists the certificate&apos;s fingerprints. A
>+      fingerprint is a unique number produced by applying a mathematical function to
>+      the certificate contents. A certificate&apos;s fingerprint can be used to verify 
>+      that the certificate has not been tampered with.</li>
>   </ul>
Rest of changes in that file are fine.

>Index: en-US/certs_prefs_help.xhtml
>===================================================================
> <head>
>-	<title>Privacy &amp; Security Preferences - Certificates</title>
>-	<link rel="stylesheet" type="text/css" href="chrome://help/locale/helpFileLayout.css" />
>+<title>Privacy &amp; Security Preferences - Certificates</title>
>+<link rel="stylesheet" type="text/css" href="chrome://help/locale/helpFileLayout.css" />
> </head>
As before <title> and <link> should be indented by 2 spaces.

>Index: en-US/composer_help.xhtml
>===================================================================
>@@ -464,50 +464,50 @@ text styles.</li>
.
.
>       <li><strong>Search backwards</strong>: Use this to search back from the insertion point to the
>-	    beginning of the page.</li>
>+        beginning of the page.</li>
>     </ul></li>
Could you split the </li> onto the following line?
.
.
>       <li><strong>Search backwards</strong>: Use this to search from the end to the beginning of the
>-	    page.</li>
>+        page.</li>
>     </ul></li>
And again.

>@@ -524,23 +524,23 @@ window:</p>
.
.
>       <li><strong>Alignment</strong>: Specify where you want to place the line (left, center, or
>-	  right).</li>
>+        right).</li>
>     </ul></li>
And again.

>@@ -629,33 +629,36 @@ not to do so.</p>
.
.
>       <li><strong>JavaScript Events</strong>: Click this tab to view or enter JavaScript events.</li>
>-        </ul></li>
>+    </ul>
>+  </li>
Like here.

>@@ -741,42 +744,44 @@ load the page into a browser window.</p>
.
.
>       <li>(Optional) Enter a size for the table width, and select either percentage of
>-	    the window or pixels.</li>
>+        the window or pixels.</li>
>       </ul></li>
Split again.

>@@ -1313,34 +1331,34 @@ background and colors</a> for every new 
.
.
>       <li>If you&apos;re creating a link to a level heading (for example, Heading 1 - Heading 6),
>-	    select it from the list of headings currently available in the page.</li>
>+        select it from the list of headings currently available in the page.</li>
>       </ul></li>
Split again.

>@@ -1491,23 +1512,23 @@ images once you insert them.</p>
.
.
>-	    Page dialog box, so you can enter the document&apos;s filename. See
>-	    <a href="#publish_page_publish">Publish Page - Publish</a> for more information.
>-		After entering the filename, click Publish.</li>
>+        Page dialog box, so you can enter the document&apos;s filename. See
>+        <a href="#publish_page_publish">Publish Page - Publish</a> for more information.
>+        After entering the filename, click Publish.</li>
>       </ul></li>
Split again.

>@@ -1694,18 +1715,20 @@ re-enter the site&apos;s settings.</p>
> <p>To delete a publishing site&apos;s settings, begin from a Composer
> window:</p>
> 
> <ol>
>   <li>Open the Edit menu, and choose Publishing Site Settings. Composer displays the Publish
>     Settings dialog box.</li>
>   <li>Select a publishing site from the list.</li>
>   <li>Click Remove Site.
>+
Why the extra line?

>     <p>Composer only removes the site&apos;s settings; the remote site itself is not
>-	  affected.</p></li>
>+      affected.</p>
>+  </li>

>@@ -2029,41 +2052,40 @@ determine what went wrong and what to do
.
.
> <ul>
> <li><strong>Site Name:</strong> Lists all the publishing sites you&apos;ve
> created, so you can choose the site that you want to publish to. To
> create a new site, click New Site.</li>
> 
> <li><strong>Page Title:</strong> Specifies the document&apos;s page title as it
No identation?

>@@ -2232,17 +2256,17 @@ steps:</p>
.
.
> <p>Composer preferences allow you to specify settings for saving
> files and for table editing. These settings apply to every document
> you create.</p>
No identation?

>Index: en-US/nav_help.xhtml
>===================================================================
>@@ -1779,45 +1778,45 @@ search, and save web pages.</p>
>     <span class="mac">&brandShortName;</span> <span class="noMac">Edit</span>
>     menu and choose Preferences.</li>
>   <li>Under the Advanced category, click Proxies. (If no subcategories are
>     visible, double-click the Navigator to expand the list.)</li>
>   <li>Select one of the following:
>     <ul>
>       <li><strong>Direct connection to the Internet</strong>: Choose this if
>         you don&apos;t want to use a proxy.</li>
>-      <li><strong>Automatically discover the proxy configuration</strong>: Choose
>-        this if you want &brandShortName; to automatically detect and configure
>-        the proxy settings, using the <a href="glossary.xhtml#wpad">WPAD
>-        protocol</a>.</li>
>-      <li><strong>Automatic proxy configuration URL</strong>: Choose this if
>-        you have a proxy configuration file or URL, then enter the configuration
>-        URL.</li>
>       <li><strong>Manual proxy configuration</strong>: Choose this if you
>-        don&apos;t have a proxy location (URL), or the automatic proxy
>-        discovery was unable to setup the proxy settings correctly.
>+        don&apos;t have a proxy location (URL).
>         <ul>
>-          <li><strong>Proxy</strong>: Enter the name or numeric IP address of
>-            the proxy server.</li>
>-          <li><strong>Port</strong>: Enter the port number in the Port field.
>-            Click on <q>Advanced</q> to set
>-            <a href="cs_nav_prefs_advanced.xhtml#advanced_proxy_preferences">Advanced
>-            Proxy Preferences</a></li>
>-          <li><strong>No Proxy for</strong>: Type the domains and/or IP 
>-            addresses that you do not want to use a proxy for. Separate each
>-            entry with a comma. (Example: <kbd>.mozilla.org, .net.nz,
>-            192.168.1.0/24</kbd>.)</li>
>+          <li><strong>HTTP Proxy</strong>, <strong>SSL Proxy</strong>,
>+            <strong>FTP Proxy, Gopher Proxy</strong>: <strong></strong>Type the
>+            name or numeric IP address of the proxy server. Type the port in
>+            the Ports field.</li>
>+          <li><strong>SOCKS Host</strong>: Enter the name or numeric IP address
>+            of the proxy server. Type the port in the Ports field.
>+            <ul>
>+              <li><strong>SOCKS v4, SOCKS v5</strong>: When entering a SOCK
>+                Host, select <q>SOCKS v4</q> or <q>SOCKS v5</q>,
>+                depending on what version of SOCKS is used for the proxy.</li>
>+            </ul>
>+          </li>
>+          <li><strong>No Proxy for</strong>: Enter the domains that you do not
>+            want to use a proxy for. Separate each domain with a comma.
>+            (Example: <kbd>.yourcompany.com, .yourcompany.co.nz</kbd>)</li>
>         </ul>
>       </li>
>+      <li><strong>Automatic proxy configuration URL</strong>: Choose this if
>+        you have a proxy configuration file or URL, then enter the configuration
>+        URL.</li>
>     </ul>
>   </li>
> </ol>
> 
> <p>Domain names are the part of a URL that contains the name of an
>-  organization, business, or school&mdash;such as mozilla.org or
>+  organization, business, or school&mdash;such as netscape.com or
>   washington.org. If you use local host names without the domain name, list
>   them the same way. Use commas to separate multiple host names. The wildcard
>   character [*] cannot be used.</p>
> 
> <p>For more information on using the Proxy preferences panel, see
>   <a href="cs_nav_prefs_advanced.xhtml#proxies">Advanced Preferences -
>   Proxies</a>.</p>
Not sure you really want to make the above changes, did you update your tree
before you diff'd?

>Index: en-US/welcome_help.xhtml
>===================================================================
> <head>
>-	<title>&brandShortName; Help</title>
>-	<link rel="stylesheet" type="text/css" href="chrome://help/locale/helpFileLayout.css" />
>+<title>&brandShortName; Help</title>
>+<link rel="stylesheet" type="text/css" href="chrome://help/locale/helpFileLayout.css" />
> </head>
<title> and <link> are usually indented by two spaces.

        Attachment #174791 -
        Flags: review?(bugzilla) → review-

    
    

    
  
(In reply to comment #5)

> <title> and <link> are usually indented by two spaces.

This is debatable, see
http://www.mozilla.org/projects/help-viewer/documentation_coding-style#whitespace


    
    

    
  
(In reply to comment #6)
> (In reply to comment #5)
> 
> > <title> and <link> are usually indented by two spaces.
> 
> This is debatable, see
> http://www.mozilla.org/projects/help-viewer/documentation_coding-style#whitespace
> 

"In general most of Help code is indented in some way.  Several tags, however,
must never be indented: <html>, <body>, and <head>. Excepting children of <body>
and <head>, all other block-level tags (whether descendant or not) must be
indented in proportion to how deeply they are nested."

hmm, I interpreted the "Excepting..." sentence that you shouldn't indent tags
inside <head>, but looking at it again I start to wonder if i misunderstood
it... However, if we want to indent <link> etc I believe there are several files
that could be fixed at the same time.


    
  

        Attachment #174791 -
        Attachment is obsolete: true

        Attachment #174800 -
        Flags: review?(bugzilla)

    
    

    
  
Comment on attachment 174800 [details] [diff] [review]
Fixed nits, uniform <title>s and <link>s, some more indentation here and there...

>Index: en-US/composer_help.xhtml
>===================================================================
.
.
>     <ul>
>       <li>(Optional) Enter a size for the table width, and select either percentage of
>-	    the window or pixels.</li>
>-      </ul></li>
>-  <li>Enter a number for the border thickness (in pixels); enter zero for no border. 
>+        the window or pixels.</li>
>+      </ul>
>+  </li>
</ul> is indented too far

.
.
>       <li><strong>Caption</strong>: Choose the caption placement from the drop-down list.</li>
>       <li><strong>Background Color</strong>: Use this to choose a color for the table background, or
>-	    leave it as transparent.</li>
>-      </ul></li>
>+        leave it as transparent.</li>
>+      </ul>
>+  </li>
and again.

.
.
> <h2 id="setting_page_properties_and_meta_tags">Setting Page Properties and Meta Tags</h2>
> 
> <p>Use the Page Properties dialog box to enter properties such as
> the title, author, and description of the document you&apos;re currently
> working on. This information is useful if you plan to use the page
Indents for this?

>@@ -1313,35 +1329,36 @@ background and colors</a> for every new 
.
.
>       <li>If you&apos;re creating a link to a named anchor (target), select it from the list of
>-	    the anchors currently available in the page.</li>
>+        the anchors currently available in the page.</li>
>       <li>If you&apos;re creating a link to a level heading (for example, Heading 1 - Heading 6),
>-	    select it from the list of headings currently available in the page.</li>
>-      </ul></li>
>+        select it from the list of headings currently available in the page.</li>
>+      </ul>
>+    </li>
</ul> and </il> are indented two spaces too far.

>@@ -1363,34 +1380,37 @@ them.</p>
.
.
>   <li>To apply additional attributes or JavaScript events, click Advanced Edit to display the
>     <a href="#using_the_advanced_property_editor">Advanced Property Editor</a>.</li>
>   <li>Click OK.</li>
>   <li>To test the link you just created, click the Browse button and then click the link to
>   make sure it works as expected.</li>
Needs an indent.

>@@ -1464,23 +1484,23 @@ pages to a remote computer called a web 
> (uploads) your pages to a computer that lets others browse your
> pages. Most ISPs provide space on their web servers for web page
> publishing. To find a web server where you can publish your pages,
> ask your ISP, help desk, or system administrator.</p>
Needs indenting.

.
.
> <p><strong>Tip</strong>: It&apos;s best to first save or publish your
> page before you insert links or images into it. This allows
> Composer to automatically use relative references for links and
Needs indenting.

>@@ -1491,24 +1511,25 @@ images once you insert them.</p>
.
.
>       <li>If you have never saved the document, Composer displays the Publish tab in the Publish
>-	    Page dialog box, so you can enter the document&apos;s filename. See
>-	    <a href="#publish_page_publish">Publish Page - Publish</a> for more information.
>-		After entering the filename, click Publish.</li>
>-      </ul></li>
>+        Page dialog box, so you can enter the document&apos;s filename. See
>+        <a href="#publish_page_publish">Publish Page - Publish</a> for more information.
>+        After entering the filename, click Publish.</li>
>+      </ul>
>+    </li>
</ul> and </li> indented too far.

.
.
> <p>When you publish a document for the first time, Composer changes
> the document&apos;s <tt>file:///</tt> URL to an <tt>http://</tt> URL to
Needs indenting.

>@@ -1661,31 +1682,28 @@ alternate site.</p>
> 
> <p>Regardless of how many sites you&apos;ve set up, you can always
> publish a document to a different site by choosing Publish As from
> Composer&apos;s File menu. See
> <a href="#changing_the_filename_or_publishing_location">Changing the Filename or Publishing Location</a>
> for more information.</p>
Needs indenting.

.
.
> <p>Deleting a publishing site removes the site&apos;s settings from
> Composer. If you later wish to publish to the site, you must
Needs indenting.

>@@ -1694,42 +1712,44 @@ re-enter the site&apos;s settings.</p>
> <p>To delete a publishing site&apos;s settings, begin from a Composer
> window:</p>
Needs indenting.

>@@ -2124,102 +2139,96 @@ as ZDNet Downloads.</p>
.
.
> <p>This section describes the settings in the Composer preferences
> panel. If you are not currently viewing the panel, follow these
Needs indenting.

>@@ -2232,17 +2241,17 @@ steps:</p>
.
.
> <p>Composer preferences allow you to specify settings for saving
> files and for table editing. These settings apply to every document
> you create.</p>
Needs indenting.

There are also some <div></div>s that are not being indented between.

>Index: en-US/mail_help.xhtml
>===================================================================
>@@ -1,22 +1,24 @@
.
.
> <div class="boilerPlate">This document is provided for your information only.
> It may help you take certain steps to protect the privacy and security of your
> personal information on the Internet. This document does not, however, address
> all online privacy and security issues, nor does it represent a recommendation
> about what constitutes adequate privacy and security protection on the
> Internet.</div>
Needs indenting.

>Index: en-US/nav_help.xhtml
>===================================================================
>@@ -17,17 +17,17 @@
.
.
> <div class="contentsBox">In this section:
> <ul>
Should we be indenting after a <div>?

help_help.xhtml probably needs to have its <title> and <link> entries corrected
too.

You also changed the <!DOCTYPE> entry for mail_help.xhtml but none of the
others, was this intended?

        Attachment #174800 -
        Flags: review?(bugzilla) → review-

    
    

    
  
Are you suggesting to fix the whole of composer_help indentation? I think it's
out of scope for this bug...
help_help and mail_help are the only 2 files with a different doctype: any
particular reason for this? Stefan?
Should we move all of them to a strictier type?
I have fixed all the errors in formatting you reported.

    
    

    
  
Yes, from the looks of it all the changes to composer_help.xhtml should probably
be spun off into a separate bug, it will make it easier to see the changes
needed for other files in this bug.

    
  
Blocks: 282893

    
    

    
  
In fact, maybe best instead off all changes to composer_help.xhtml, just the
<div> changes along with any files' <div> changes. Created bug 282893 for that.

    
    

    
  
> help_help and mail_help are the only 2 files with a different doctype: any
> particular reason for this? Stefan?
> Should we move all of them to a strictier type?

All Help files should have the xhtml 1.1 doctype. Some files used to have
target="_blank" and those had the transitional doctype. I have a fix in bug
280094, feel free to incorporate that in your patch. But don't change all the
copyright lines as I did ;)



    
    

    
  
(In reply to comment #13)
> All Help files should have the xhtml 1.1 doctype. Some files used to have
> target="_blank" and those had the transitional doctype. I have a fix in bug
> 280094, feel free to incorporate that in your patch. But don't change all the
> copyright lines as I did ;)

Ok, changed locally all of doctypes. Waiting for reviews/checkins for patches in
bug 282893 before providing a newer patch.

    
    

    
  
Fixed all of these while fixing bug 282893. Please close as fixed!
TIA, Giacomo.

    
    

    
  
(In reply to comment #15)
> Fixed all of these while fixing bug 282893. Please close as fixed!
> TIA, Giacomo.

--> Fixed
Status: NEW → RESOLVED
Closed: 20 years ago
Resolution: --- → FIXED

          You need to log in
          before you can comment on or make changes to this bug.
        






  

    
  







  

    

      
Attachment

      

      
      
      
      
    

    

      

        

          

            
General

            

              Creator: 



            

            
Created: 

            
Updated: 

            
Size: