Java_Mode_Tamed/README.html at reluk.ca · Michael-Allan/Java_Mode_Tamed · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<!-- - -
 ! Omit the <html>, <head> and <body> tags, this file may be targeted as an index footer
 ! by Apache `ReadmeName` directives.  http://httpd.apache.org/docs/2.4/mod/mod_autoindex.html
 ! Use Markdown compatible HTML, this file is targeted as a Git Hub adaptor by symlink `README.md`. -->
<h1 lang='en-CA'>Java Mode Tamed</h1>
<section lang='en-CA'> <!-- Introduction -->
    <p>
        This project implements JMT Mode, an Emacs major mode that affords better control
        of its built-in Java mode, particularly in regard to syntax highlighting.  For this,
        it introduces customizeable faces to highlight the following syntax features.</p>
    <ul>
        <li>Annotation details</li>
        <li>Delimiters (quotes, various forms of bracket and separator)</li>
        <li>Javadoc details</li>
        <li>Keywords, according to role</li>
        <li>Named literals: `true`, `false`, `null`</li>
        <li>Package-declaration details</li>
        <li>Shebang</li>
        <li>Type identifiers at point of declaration (as opposed to reference)</li>
        <li>Type variables at point of declaration</li></ul>
    <p>
        Additionally it corrects the highlighting of features that are mishandled by the built-in mode,
        such as:</p>
    <ul>
        <li>Annotations</li>
        <li>Assert statements</li>
        <li>Enhanced `for` loops</li>
        <li>Javadoc block tags</li>
        <li>Method and constructor declarations</li>
        <li>Multi-type catch parameters</li>
        <li>Records</li>
        <li>Static imports</li></ul></section>
<section lang='en-CA' id='Screen shots'>
    <h2>Screen shots</h2>
    <ol>
        <li><a href='http://reluk.ca/project/Java/Emacs/screen_shot/1_before.png'>Before</a></li>
        <li><a href='http://reluk.ca/project/Java/Emacs/screen_shot/2_after.png'>After</a></li>
        <li><a href='http://reluk.ca/project/Java/Emacs/screen_shot/3_after_customization.png'>
            After customization</a></li></ol></section>
<section lang='en-CA' id='Installation'>
    <h2>Installation</h2>
    <p>
        You can install JMT Mode from <a href='https://melpa.org/#/jmt-mode'>
        MELPA</a> using a package manager such as
        `<a href='https://www.gnu.org/software/emacs/manual/html_node/emacs/Packages.html'>
        package.el</a>`.  Or you can install it manually.</p>
    <p>
        See `<a href='jmt-mode.el'>jmt-mode.el</a>` for instructions.</p></section>
<section lang='en-CA' id='Copying'>
    <h2>Copying</h2>
    <p>
        Copyright © 2019-2024  Michael Allan.
        The files for this project are released under an <a href='LICENCE.txt'>
        MIT licence</a>.</p>
    <ul><li>Browsable <a href='http://reluk.ca/project/Java/Emacs/'>project files</a>.</li>
        <li>Browsable <a>revision history</a>.* (top of this page)</li>
        <li>Bare `.git` repository at
            <a href=    'http://reluk.ca/var/repo/git/Java_Mode_Tamed.git'>reluk.ca</a>, mirror at
            <a href='https://github.com/Michael-Allan/Java_Mode_Tamed.git'>github.com</a>.*
            <div style='margin:0.5em 1.0em'>
               git clone http://reluk.ca/var/repo/git/Java_Mode_Tamed.git</div></li></ul>
    <p style='opacity:0.7'><small>
        * Includes branch `reluk.ca` which is liable to rebasing, and `master` which is not.
        </small></p></section>
<script src='http://reluk.ca/project/autoindex.js'></script>
<script> // Inadvertently these `script` elements render when viewed on Git Hub.
    if( document.URL.indexOf('//github.com/') < 0 ) {
        ca_reluk_project.amend( /*properPath*/'Java/Emacs', /*tokenName*/'Java_Mode_Tamed' ); }
    </script>