Update for Javatar 1.0.0

spywhere · Dec 20, 2014 · 948ebd3 · 948ebd3
1 parent c4c6b61
commit 948ebd3
Show file tree

Hide file tree

Showing 16 changed files with 91 additions and 83 deletions.
diff --git a/README.md b/README.md
@@ -2,4 +2,4 @@
 
 A source for JavatarDoc on readthedocs.org
 
-JavatarDoc: [https://javatar.readthedocs.org/](https://javatar.readthedocs.org/)
+JavatarDoc: [https://javatar.readthedocs.org/](https://javatar.readthedocs.org/)
diff --git a/actions_history.rst b/actions_history.rst
@@ -12,7 +12,7 @@ A |J| Action History Report will looks similar to this when using it properly...
 
 	## Javatar Report
 	### System Informations
-	* Javatar Version: `14.04.15.00.29b`
+	* Javatar Version: `1.0.0`
 	* Sublime Version: `3059`
 	* Package Path: `/Users/USER_NAME/Library/Application Support/Sublime Text 3/Packages`
 	* Javatar Channel: `stable`
@@ -54,4 +54,4 @@ A |J| Action History Report will looks similar to this when using it properly...
 
 |J| **do not** automatically send these informations. You have to reply an issue with these informations yourself.
 
-Actions History can be disabled by settings ``enable_actions_history`` to ``false``.
+Actions History can be disabled by settings ``enable_actions_history`` to ``false``.
diff --git a/adv_creates.rst b/adv_creates.rst
@@ -23,6 +23,12 @@ See examples below...
 | ~Alpha.Beta | ``Package "Beta" is created in "Alpha"``                           | ``Class "Beta" is created in "Alpha"``                           |
 +-------------+--------------------------------------------------------------------+------------------------------------------------------------------+
 
+Classes with main method
+------------------------
+
+To create a class with main method, just add ``AsMain`` at the end of your class name.
+|J| will automatically add main method when the class is created.
+
 Customized Classes
 ------------------
 

diff --git a/bindings.rst b/bindings.rst
@@ -26,11 +26,11 @@ All commands start with :kbd:`Key+Shift+K` then follows by their shortcut key.
     * This will open quick panel, showing you all possible types to create.
 * Create new package : :kbd:`Key+Shift+P`
 	* This will open input panel, just like when you create a new package.
-* Organize Imports : :kbd:`Key+Shift+I` (Only on development channel)
+* Organize Imports : :kbd:`Key+Shift+I`
 	* This will organize imports on current file.
-* Project Settings : :kbd:`Key+Shift+.` (Not available at this moment)
+* Project Settings : :kbd:`Key+Shift+,`
 	* This will open quick panel, showing you all settings you can adjust for current project.
-* Javatar Settings : :kbd:`Key+Shift+,` (Not available at this moment)
+* Javatar Settings : :kbd:`Key+Shift+.`
 	* This will open quick panel, showing you all settings you can adjust for global projects.
 
 .. note:: :kbd:`Key` is :kbd:`Control` on Windows, Linux and :kbd:`Command` on OS X.
diff --git a/changelogs.rst b/changelogs.rst
@@ -0,0 +1,28 @@
+.. include:: definitions.inc
+
+.. _changelogs:
+
+Release Changelog
+=================
+
+First release (20 December 2014)
+--------------------------------
+
+* Create packages
+* Create classes, enumerators, interfaces
+* Class corrections
+* Build System
+* Action History
+* Organize imports
+* Javatar packages
+* Javatar stats and usages
+* Project Settings
+* Javatar shells and run class feature
+* Compilation errors and StackTrace code highlighting (syntax files)
+* Parallel build threads
+* Dependency settings
+* Installed JDKs settings and automatic detection
+* Project data restoration
+* Build notifications via SubNotify
+* Program argument settings
+* Build and Run outputs' target group settings
diff --git a/commands.rst b/commands.rst
@@ -29,16 +29,16 @@ Create
 Operations
 ----------
 
- * Do class or package operations such as organize imports, rename class or package
+ * Do class or package operations such as organize imports or correct class
  * More details on :ref:`operations`
 
-Project Settings [#qm_only]_
+Project Settings
 ----------------------------
 
  * Adjust settings for current projects
  * More details on :ref:`projects`
 
-Javatar Settings [#qm_only]_
+Javatar Settings
 ----------------------------
 
  * Adjust settings for global projects (all projects)

diff --git a/commands_list.rst b/commands_list.rst
@@ -21,18 +21,19 @@ Here is the list of commands available via |J|'s menu.
     * Class Name
  * Create...
     * Package
-    * Abstract Class
     * Class
     * Enumerator
     * Interface
     * And your own |J|'s snippets
  * Operations...
+    * Organize Imports
     * Correct Class
  * Project Settings...
+    * Set Program Arguments
+    * Set Source Folder
     * Dependencies...
        * Add External .jar
        * Add Class Folder
-    * Set Source Folder
     * Set Default JDK
  * Javatar Settings...
     * Dependencies...
@@ -51,9 +52,6 @@ Here is the list of commands available via |J|'s menu.
        * Generate SHA-256 Hash from URL
        * Convert Imports
  * Development Section... [#dev]_
-    * Operations: Organize Imports
-    * Operations: Rename Class
-    * Operations: Rename Package
     * Parse Document
     * Prettify JSON
     * Testing
@@ -65,4 +63,4 @@ Here is the list of commands available via |J|'s menu.
 .. [#debug] Available in debug mode
 .. [#dev] Available in development channel
 
-.. Note:: Menu item ends with ellipsis (3 dots) indicated that menu has submenus.
+.. Note:: Menu item ends with ellipsis (3 dots) indicated that menu has submenus.
diff --git a/conf.py b/conf.py
@@ -12,7 +12,6 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
 import os
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -44,16 +43,16 @@
 
 # General information about the project.
 project = u'Javatar'
-copyright = u'2014, Sirisak Lueangsaksri'
+copyright = u'2015, Sirisak Lueangsaksri'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '14.09.26.13.45b'
+version = '1.0.0'
 # The full version, including alpha/beta/rc tags.
-release = '14.09.26.13.45b'
+release = '1.0.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -67,7 +66,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ['_build', '_themes']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -188,22 +187,22 @@
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+    # The paper size ('letterpaper' or 'a4paper').
+    #'papersize': 'letterpaper',
 
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+    # The font size ('10pt', '11pt' or '12pt').
+    #'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # Additional stuff for the LaTeX preamble.
+    #'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'Javatar.tex', u'Javatar Documentation',
-   u'Sirisak Lueangsaksri', 'manual'),
+    # ('index', 'Javatar.tex', u'Javatar Documentation',
+    #  u'Sirisak Lueangsaksri', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -246,9 +245,9 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'Javatar', u'Javatar Documentation',
-   u'Sirisak Lueangsaksri', 'Javatar', 'A Sublime Text 3 Plugin for Java Development.',
-   'Miscellaneous'),
+    ('index', 'Javatar', u'Javatar Documentation',
+     u'Sirisak Lueangsaksri', 'Javatar', 'A Sublime Text 3 Plugin for Java Development.',
+     'Miscellaneous'),
 ]
 
 # Documents to append as an appendix to all manuals.

diff --git a/features.rst b/features.rst
@@ -7,23 +7,14 @@ Features
 
 |J| is designed to be *IDE-like* plugin by providing many features that help develop Java applications faster and easier.
 
- * [S]_ Packages and Subpackages creation
- * [S]_ Class (also Abstract), Interface and Enumeration snippets with package/class name auto-complete
- * [S]_ Project/Package/Class build and run with dependencies [#1]_
- * [S]_ Packages path in status bar
- * [S]_ External libraries packages
- * [S]_ Internal console with input supports
- * [D]_ Organize Imports [#1]_
- * [P]_ Rename/Move packages or classes [#2]_
- * [P]_ .jar file export (includes executable .jar) [#3]_
- * [P]_ Dynamic method call auto-complete
+ * Packages and Subpackages creation
+ * Class (also Abstract), Interface and Enumeration snippets with package/class name auto-complete and auto-import
+ * Project/Package/Class build and run with dependencies [#1]_
+ * Packages path in status bar
+ * External libraries packages
+ * Internal console with input supports
+ * Organize Imports [#1]_
 
-|J| is currently on Beta.
-
-.. [S] Available on stable channel
-.. [D] Partial available on development channel
-.. [P] Planned
+For full feature list, please see :ref:`changelogs`
 
 .. [#1] Organize Imports will not support classes inside dependencies except provided by :ref:`javatar_packages`
-.. [#2] Auto-refactor is not included
-.. [#3] Export as executable JAR may delay after normal JAR export feature is finished
diff --git a/index.rst b/index.rst
@@ -19,7 +19,8 @@ Table of Contents
    :maxdepth: 3
 
    features
-   updates
+   installation
+   changelogs
    screenshots
    getting_started
    commands_list
@@ -29,10 +30,9 @@ Table of Contents
    adv_creates
    operations
    projects
+   settings
    default_packages
    jdk_detection
-   installation
-   settings
    bindings
    build_system
    javatar_shell

diff --git a/javatar_shell.rst b/javatar_shell.rst
@@ -10,4 +10,4 @@ The difference between |J| shell and another shells is |J| shell will send your
 
 While |J| shell is running, you can close the view to force quit any application that still running in the shell.
 
-.. warning:: We cannot gurranteed that output or input is corrected when you are enter while |J| shell is printing an output from the shell since |J| shell did not set the view to read-only while printing.
+.. warning:: |J| cannot gurranteed that output or input is corrected when you are enter while |J| shell is printing an output from the shell since |J| shell did not set the view to read-only while printing.
diff --git a/javatar_snippets.rst b/javatar_snippets.rst
@@ -3,7 +3,7 @@
 .. _javatar_snippets:
 
 |J| Snippets
-================
+============
 
 |J| snippets is a dynamic snippet which will change part of the file to correspond with package path and class name. By using parameters, you can specify which part of the file you want to fill the data to.
 
@@ -27,7 +27,7 @@ Usage of snippet tags in action
 .. image:: images/CreateNewSS.png
 
 Snippet Parameters
---------------
+------------------
 
 The following parameters are used inside |J| snippet files (\*.javatar) which will be parsed by |J| and |st|.
 

diff --git a/package_channels.rst b/package_channels.rst
@@ -22,4 +22,6 @@ Package Updates Notifications
 -----------------------------
 
 In order to notice important notes to all users, in stable channel or development channel or both, |J| use custom notification system which will notice you **only once** when |J| is ready to use.
-You can opt out this notification by settings ``message_id`` to ``-1`` in |J|'s user settings file, note that you can see update notes in README file or you will miss further important update notes.
+You can opt out this notification by settings ``message_id`` to ``-1`` in |J|'s user settings file, note that you can see update notes in README file or you will miss further important update notes.
+
+.. note:: From |J| 1.0.0 and later, Package Channels has no effect on features except for *Development Section*. There will be no package channel on newer version of |J|.
diff --git a/projects.rst b/projects.rst
@@ -10,9 +10,9 @@ The Project Settings section contains per-project settings.
 .. tip:: All |J|'s settings can be set specifically for each project by setting it in project file instead of user preferences
 
 Set Program Arguments
------------------
+---------------------
 
-By default, |J| will not pass parameters when running an application through the *run* command (see :ref:`getting_started` for an example).
+By default, |J| will not pass parameters when running an application through the *Run Main Class* command (see :ref:`getting_started` for an example).
 *Set Program Arguments* allows you to specify what arguments should be passed on main execution.
 
 Dependencies

diff --git a/updates.rst b/updates.rst
diff --git a/year_book.rst b/year_book.rst
@@ -7,6 +7,16 @@ Year Book
 
 A lookback of |J| over years...
 
+20 December 2014...
+-------------------
+
+|J| has reach its first release!
+
+Stats: 10.0k installs
+
+Take a look of full feature list here :ref:`changelogs`
+
+
 15 June 2014...
 ---------------