Fixes /help formatting

arXiv · Nov 17, 2022 · 2ac6c01 · 2ac6c01
1 parent 64b62e7
commit 2ac6c01
Show file tree

Hide file tree

Showing 77 changed files with 307 additions and 803 deletions.
diff --git a/source/corr/subjectclasses.md b/source/corr/subjectclasses.md
diff --git a/source/help/announcement.md b/source/help/announcement.md
diff --git a/source/help/announcement.md~ b/source/help/announcement.md~
diff --git a/source/help/bitmap/index.md b/source/help/bitmap/index.md
@@ -1,9 +1,8 @@
-Bitmapping Figures
-==================
+# Bitmapping Figures
 
 arXiv strongly recommends using bitmapped formats when possible. Data files that
 make up plots should be included within the tex source as [ancillary files](../../help/ancillary_files.md)
-for both archival storage as well as figure reproducibility. 
+for both archival storage as well as figure reproducibility.
 
 Historically, graphics and plotting programs do not take into account that people
 might want to send their output over the internet instead of to a local
@@ -14,7 +13,7 @@ For example, many data-plotting programs use unnecessarily long
 PostScript commands when plotting a point or line. If there are large
 numbers of data points, then this can add hundreds of kilobytes to the
 file size. For figures produced from programs like this, it is more
-efficient to use a bitmap to describe the entire image. 
+efficient to use a bitmap to describe the entire image.
 
 **Note:**  
 If you have **eps** figures, which have been flagged by the arXiv system

diff --git a/source/help/config_browser.md b/source/help/config_browser.md
@@ -1,5 +1,4 @@
-Configuring Your Browser
-========================
+# Configuring Your Browser
 
 In order to seamlessly download and view documents from arXiv, you may
 have to configure your web browser. It must be told what types of files

diff --git a/source/help/contact.md b/source/help/contact.md
@@ -1,13 +1,12 @@
-Contacting arXiv
-===============================
+# Contacting arXiv
 
 ## Technical queries
 
-If you have questions about paper submission, accounts, and use of arXiv, please first review [help](index.md) and [FAQ](faq/index.md). 
+If you have questions about paper submission, accounts, and use of arXiv, please first review [help](index.md) and [FAQ](faq/index.md).
 
 Contact our User Support team via the [arXiv user support portal](http://arxiv.org/support/general_help).
 
-Note that our user support team typically operates 0900-1700 EST/EDT, Monday through Friday. Most requests are responded to by the end of the day, subject to staff availability and holidays. 
+Note that our user support team typically operates 0900-1700 EST/EDT, Monday through Friday. Most requests are responded to by the end of the day, subject to staff availability and holidays.
 
 To avoid a delay in receiving a response:
 
@@ -33,14 +32,14 @@ Information about institutional membership or contributions to arXiv can be foun
 ## Copyright infringement
 
 To contact Cornell University's designated agent for alleged copyright infringement, in accordance with the Digital Millennium Copyright Act,
-see [Copyright Infringements](http://www.cornell.edu/copyright-infringement.cfm). 
+see [Copyright Infringements](http://www.cornell.edu/copyright-infringement.cfm).
 
 <span id="figures"></span>
 **Note:** For queries regarding figure reuse for your manuscript, please contact the submitter or copyright holder directly.
 
 ## Authorship Disputes
 
-arXiv will not adjudicate [authorship disputes](authority.md#coauthor) within a collaboration of authors. 
+arXiv will not adjudicate [authorship disputes](authority.md#coauthor) within a collaboration of authors.
 
 ## Code of Conduct concerns
 

diff --git a/source/help/cross.md b/source/help/cross.md
@@ -1,6 +1,6 @@
-To cross-list an article to another category
-============================================
+# Crosslisting articles
 
+## To cross-list an article to another category
 You may feel that your article is of direct interest to the readers of a
 category other than the one to which you submitted your article. In such
 cases you may cross-list your article to the other category so that your

diff --git a/source/corr/index.md → source/help/cs/index.md b/source/corr/index.md → source/help/cs/index.md
@@ -1,4 +1,4 @@
-### Welcome to the Computing Research Repository (CoRR)
+# Computer Science archive
 
 Welcome to the Computing Research Repository (CoRR) in arXiv. The Computer Science section of arXiv was established in 1998 through a partnership of the Association for Computing Machinery, the Networked Computer Science Technical Reference Library, and arXiv.
 
@@ -25,4 +25,3 @@ The advisory committee members serve as consultants to Cornell University and to
 - Erik Sandewall, Linkoping, Sweden  
 - Stuart Shieber, Harvard  
 - Jeff Ullman, Stanford  
-
diff --git a/source/help/donate.md b/source/help/donate.md
diff --git a/source/help/econ/announcement.md b/source/help/econ/announcement.md
diff --git a/source/help/eess/announcement.md b/source/help/eess/announcement.md
diff --git a/source/help/eess/announcement.md~ b/source/help/eess/announcement.md~
diff --git a/source/help/faq/doublesubscript.md b/source/help/faq/doublesubscript.md
@@ -1,5 +1,4 @@
-Examples of TeX Double Subscripts
-=================================
+# Examples of TeX Double Subscripts
 
 In the examples below (1) is incorrect and gives a LaTeX error. A
 &lt;RETURN&gt; leads to the same interpretation as (2). However, there

diff --git a/source/help/faq/index.md b/source/help/faq/index.md
@@ -1,4 +1,4 @@
-# Frequently Asked Questions (FAQ)
+# Frequently Asked Questions
 
 ## Information About Downloading and Viewing Files
 
@@ -68,4 +68,3 @@
   - [Trackbacks - Links to blogs](../../help/trackback.md)
   - [Why don't you release statistics about paper
     retrieval?](statfaq.md)
-
diff --git a/source/help/faq/today.md b/source/help/faq/today.md
@@ -1,5 +1,4 @@
-Why Does My Paper Give the Wrong Date?
-======================================
+# Why Does My Paper Give the Wrong Date?
 
 If you have a LaTeX submission that uses the `\today` macro to get the date, either explicitly or by default from a style file, then this will show the date the file was processed. We do not store the PS or PDF generated from LaTeX submissions long-term. Instead, we generate these formats from the source when they are requested (the output is cached for a time that depends on availability of space and access pattern). Thus the source will likely be processed at different times after the initial submission and dates created with the `\today` macro will reflect this.
 
@@ -8,4 +7,4 @@ Solution
 
 Do not use the `\today` macro, and correctly override default dates supplied by style files.
 
-We consider the date stamped on the left hand side of the page, along with the paper identifier, to be definitive. Dates in the paper are supplied by the submitter and we have no control over them. We have considered overriding the `\today` macro, but believe that this would cause more problems than it cures. The correct solution is as noted above.
+We consider the date stamped on the left hand side of the page, along with the paper identifier, to be definitive. Dates in the paper are supplied by the submitter and we have no control over them. We have considered overriding the `\today` macro, but believe that this would cause more problems than it cures. The correct solution is as noted above.
diff --git a/source/help/faq/whytex.md b/source/help/faq/whytex.md
@@ -1,5 +1,4 @@
-Why Submit the TeX/LaTeX Source?
-================================
+# Why Submit the TeX/LaTeX Source?
 
 1.  TeX has many advantages that make it ideal as a format for the archives: It is plain text, it is compact, it is freely available for all platforms, it produces extremely high-quality output, and it retains [contextual information](#contextual).  
     It is thus more likely to be a good source from which to generate newer formats, e.g., MathML \[namely HTML, or more specifically XML, that handles mathematics correctly -- note that the MathML people plan a LaTeX to MathML translator, but dvi/ps/pdf lack the necessary document structuring concepts\]. Possession of the source thus provides many additional options for future document migrations.
@@ -32,29 +31,29 @@ Frequent Red Herring Concerns:
 ------------------------------
 
 *   **Will the auto-TeXing embed figures?**
-    
+
     Yes. Our TeX installation can do anything that yours can. Any macros you use that we do not support can be included in your submission (or sent to us separately so we can put them on-line).
-    
+
 *   **Won't TeX source make it easy to plagiarize?**
-    
+
     There is no file format or other technological device that can protect you from this. At the very least, unscrupulous re-typers would always remain a threat. Postscript does not provide a barrier in any event: it is quite simple for someone with a little knowledge to extract any text from a Postscript file. Moreover a plagiarist who cuts-and-pastes directly from your TeX source is all the more easily detected, since the source is easily identified. We archive all versions of papers so that we can assist in any priority or plagiarism disputes.
-    
+
 *   **I worked hard to make my figures and I don't want people to steal them. Shouldn't I hide them by embedding them?**
-    
+
     As with the above question, it is quite easy for someone with a little knowledge to extract anything they like from the output PDF or Posctript file. Furthermore, unauthorized or un-attributed use of figures counts as plagiarism, just as above, so the rest of the above discussion applies here as well.
-    
+
 <span id="comments"></span>
 
 *   **What if my TeX source has potentially embarrassing self-comments in it?**
-    
+
     Well... you should probably take them out. It is easy to strip these out in advance of submitting. Here is a Perl filter to do it. Please, please do not hurt yourself with this script; save your file and do not write over the backup copy... just in case.
 
 ```perl  
   #!/usr/local/bin/perl  
   while(<STDIN>){ s/^\%.*$/\%/; s/([^\\])\%.*$/\1\%/g; print; }  
   exit(0);  
 ```
-    
+
 or use the one line command
 
 ```bash    
@@ -68,5 +67,5 @@ or use this third-party tool, [`arxiv-latex-cleaner`](https://github.com/google-
 ```
 
 *   **I use the Textures program. Won't the archive destroy my paper's beautiful formatting?**
-    
+
     We have many Textures submissions here. Figures will, of course, be placed exactly where you put them (why would you expect otherwise?). Textures does use a non-standard command to control the way figures are included, please read our [notes on submitting Textures generated papers](textures.md).
diff --git a/source/help/find.md b/source/help/find.md
@@ -1,16 +1,11 @@
-To find an article
-==================
-
-Search
--------------
+# Finding Articles
 
+## Search
 Enter a few title words and/or author names and/or abstract words into
 the "**Search or Article-id**" box in the top right of most pages
 (including this one) or you can use the [Advanced Search](bitmap/advanced.md)
 
-If you know the identifier
---------------------------------------------------------
-
+## If you know the identifier
 All arXiv submissions are assigned a unique identifier of the form
 `yymm.nnnnn` (or `arch-ive/yymmnnn` for older submissions). To retrieve
 the abstract page a paper simply enter the identifier in the "**Search

diff --git a/source/help/general.md b/source/help/general.md
diff --git a/source/help/hypertex/X/index.md b/source/help/hypertex/X/index.md
@@ -1,5 +1,5 @@
-External URL's under X
-======================
+# External URL's under X
+
 ```
 Date: Sat, 16 Jul 94 12:49:47 MDT
 From: tanmoy@qcd.lanl.gov (Tanmoy Bhattacharya)
@@ -30,4 +30,4 @@ Anyway, here is how the system on nqcd works. No portability issues had been con
     6.  checks to see if process with PID `x` exists and its identification as returned by ps contains the string \`Mosaic'. If so goto step 6. (BSD and SYSV ps calls may differ). (Note that it does not check to see if the DISPLAY is the same! See point 2)
     7.  Start a Mosaic passing it the first parameter; and exit when that exits. (should probably \`exec' the Mosaic instead. Should it also try a ps -x and check for an unique Mosaic on this display before it starts a new one? See point 2 about display). (The redirection of standard output to standard error stays!) (What happens if the parameter contains backquotes? Haven't checked!)
     8.  Creates `/tmp/Mosaic.x` (`x` being the aforementioned pid) and writes two lines into it (probably crashes if it cannot): the first being \`goto' and the second contains whatever came in as the first parameter. Then it signals USR1 to x, and exits. (probably should write the second parameter as a third line.) (What happens if the parameter contains backquotes? Haven't checked!)
-    9.  Note that the second parameter is always ignored. (It is supposed to be the BASE HREF of the document which is calling callmosaic).
+    9.  Note that the second parameter is always ignored. (It is supposed to be the BASE HREF of the document which is calling callmosaic).
diff --git a/source/help/hypertex/bugs.md → source/help/hypertex/bugs.md~ b/source/help/hypertex/bugs.md → source/help/hypertex/bugs.md~
diff --git a/source/help/ir.md b/source/help/ir.md
@@ -1,15 +1,13 @@
-Institutional Repository (IR) Interoperability
-==============================================
+# Institutional Repositories
 
+## Introduction to Institutional Repository (IR) Interoperability
 arXiv places no restrictions on whether articles also appear in local
 institutional repositories. Authors are welcome to download copies of
 their own articles from arXiv in order to submit to a local repository.
 This page describes ways in which institutional repository managers may
 approach finding and copying local researchers' content from arXiv.
 
-Copying content from arXiv to an IR
------------------------------------
-
+## Copying content from arXiv to an IR
 Some institutions require or request that copies of articles written by
 their researchers are deposited in their local institutional repository
 in addition to arXiv. Everything necessary to pull complete metadata and
@@ -32,12 +30,10 @@ Obtaining permission from the article authors may not be necessary if:
     researchers' articles into an institutional repository.
 
 ### Procedure
-
 We will consider the article [arXiv:1410.6579](https://arxiv.org/abs/1410.6579) as an
 example.
 
 #### Step 1 - Get metadata
-
 Metadata from arXiv is available via our [OAI-PMH interface](oa/index.md),
 the URI for different metadata formats is constructed based on the
 article identifier. For example, to get `oai_dc` metadata the request
@@ -65,7 +61,7 @@ The Public Domain Dedication allows and article to be copied to another
 repository without the need to ask for permission. Most submissions to
 arXiv use the default license however, expressed with the URI:
 
-     
+
     ...
       <license>http://arxiv.org/licenses/nonexclusive-distrib/1.0/</license>
     ...
@@ -102,8 +98,7 @@ denial-of-service attack detector cutting off access, please contact
 [arXiv support](support.md) if you intend to download more than a
 thousand articles.
 
-Identifying articles by your institution's researchers
-------------------------------------------------------
+## Identifying articles by your institution's researchers
 
 Unfortunately, most arXiv articles do not have any affiliation
 information included by submitters, and when it is present there is wide

diff --git a/source/help/jref.md b/source/help/jref.md
@@ -1,5 +1,6 @@
-To add a journal reference, DOI or report number to an article
-==============================================================
+# Add Journal Reference
+
+## To add a journal reference, DOI or report number to an article
 
 When a article is published, the author may wish to indicate this in the
 abstract listing for the article. For this reason, the journal reference
@@ -13,8 +14,7 @@ page](http://arxiv.org/jref). Note that no new article version will be
 generated when journal reference, DOI or report number information is
 added.
 
-Journal reference
------------------
+## Journal reference
 
 Note that this is relevant only when the author has the full publication
 information. Messages of the form "will appear in..." or "accepted
@@ -30,8 +30,7 @@ year and page number(s)**. An example looks like:
 
 See also [journal reference](prep.md#journal) formatting details.
 
-DOI
----
+## DOI
 
 DOIs are identifiers that provide access to electronic versions of
 journal articles. They will be linked from the arXiv abstract page. They
@@ -42,8 +41,7 @@ prefix such as `doi:`. For example:
 
 See also [DOI](prep.md#doi) formatting details.
 
-Report number
--------------
+## Report number
 
 This is for your institution's locally assigned publication number or
 numbers. These usually comprise a prefix of a few letters and then