guillermooo / sublime-undocs Goto Github PK

Hi, its possible to update the documentation with the _Naming Conventions_ for syntax files?
You can search the some information here (I believe that is the same for sublime):
http://manual.macromates.com/en/language_grammars

In the Build Systems section of the docs, I came across a small error in the markdown parsing. Under Variants, the word "name" is supposed to be highlighted like so - using double backticks to enclose it. The page seems to be displaying the backticks as raw text, and won't apply the proper formatting.

Interestingly enough, I also noticed that the first pair of improperly displayed backticks links to the current page (aka the Build Systems page). This is probably contributing to the formatting error.

Recent screenshot:

It would be great to see clarification in search_and_replace/search_and_replace_files.rst on how the include and exclude patterns interact with each other, and what the pattern syntax is (if that's covered elsewhere in docs it could be linked to)

For example, the filter *.cpp,-ut_*.cpp includes files matching the exclude filter, so it's clearly not a left-to-right ordered filter sequence. Same if pattern order is reversed. Does the search filter support such usage in some other way?

Should read "highlight_modified_tabs"

I would like to edit and add to the HTML completions in ST3 but I am struggling to find out how to do it.

I created an HTML.sublime-completions file in my User folder, but when I added some completions that started with the reserved character < and added "auto_complete_triggers": [ {"selector": "text.html", "characters": "&<"} ], in my Preferences.sublime-settings, the HTML completions built into ST3 (which I think depend on the < character) stopped working.

I read that the built in autocompletions are contained in the HTML.sublime-package in the packages folder under the folder that ST3 itself is installed in, so I copied this and extracted the files within it, which are:

Comments.tmPreferences
encode_html_entities.py
html.sublime-snippet
HTML.tmLanguage
html_completions.py
Miscellaneous.tmPreferences
Symbol List - ID.tmPreferences

But when I studied these I was not sure which one I needed to edit, or where to put the edited file - or do I need to put all the files somewhere? Can you give any hints or point to documentation on how to edit and add to the HTML autocompletions that are built into ST3?

Thanks for any help.

Kind regards - David

#107 didn't work

In the "Your First Plugin..." section, the first step is:

Select Tools | New Plugin... in the menu.

It is actually Tools | Developer | New Plugin...

*cough* I am ashamed to say it took me twenty minutes to get past this step.

Hello,

I'm not seeing the symbols properly whilst using Mac OSX Chrome Version 51.0.2704.106 (64-bit).

It is working good on Firefox and Safari though.

Please see screenshot below.

Kind regards,

sumnermic

https://github.com/FichteFoll/UnofficialDocs/issues/7

There's a lot of stuff missing here. :(

i am making sublime package and it has a web server and listens to some port and gets some commands from browser
first command i want to make is open file
so i am getting file path opening file but sublime text window not getting active
i found that i can execute sublime_text.exe in shell and sublime text window gets activated but how to chose which window to get active

Hi, i'm from Brazil and i want translate doc to portuguese.
Can i do it?

There is something annoying. If we put on the option "In selection" the selection get deselected!

Sorry but for me personally this is the most disadvantage (there are some more), as I'm not used to it from any other editor I used before.

PS: And where is the amount of replacements displayed?

Thanks for the nice editor.

I know this is changing frequently, with the rash of new releases in the past few weeks, but it would be great if we could add some details on the new tooltip API and minihtml specs. I'd love to play around with it some, but it's been kind of difficult to follow all the different threads on the forum, and to find some good working examples.

Ultimately, I'd like to enter my company's license key via boxen. Is there a way to enter the key with subl or by editing some config file? Thanks.

I think it would be useful to add more information about how file_include_patterns, file_exclude_patterns, folder_include_patterns and folder_exclude_patterns work. (And binary_file_patterns?)

I've written a little bit about it on the ST3 forums: https://forum.sublimetext.com/t/explained-sublime-project-file-folder-exclude-patterns/19997/2

When visiting from https://docs.sublimetext.info/en/latest/ (as linked from https://www.sublimetext.com/support), we're presented with a "net::ERR_CERT_COMMON_NAME_INVALID" error.

from: https://github.com/FichteFoll/UnofficialDocs/issues/15

Since I will likely forget about what features are currently not documented in the official API Docs and do not have the time to add them all I'm creating an issue here to keep track of all the missing things.

• EventListener.on_query_completions(self, view, prefix, locations) which allows two different return types and sublime.INHIBIT_WORD_COMPLETIONS, used as a second return value when a tuple
• The *Command.*_ methods with the event parameter and unwrapped args (e.g. "run_", "is_enable_")?
• *Command.is_checked for use as a menu item command
• sublime_plugin.run_timed_function(f, name, event_name, timeout) usually not necessary to call since it's already used on direct plugin calls but maybe interesting for multi-threaded stuff?
• sublime_plugin.reload_plugin(fname) should not be used regularly but still interesting?

Quick edit:

• Completions (.sublime-completions file as well as generated by event listeners) support displaying a description which can be added by separating it with \t in the "trigger" key. Example:

  {"trigger":"abs\tabs(...)", "contents": "abs(${1:x})"}

It will be useful to mention how to disable disturbing key bindings.

Example:
To disable toggle_overwrite on macOS add { "keys": ["super+alt+o"], "command": "noop" } in your key map.

It must be in the section Key Bindings.

source/getting_started/install.rst

Per: http://standards.freedesktop.org/desktop-entry-spec/latest/ar01s05.html

The "Version" key refers to the version of the desktop standard that is being used, not the version of the application. It should be "1.0" if you include it at all.

Hi,

Sorry for all the issues, especially if you are tracking your "todo" list elsewhere and I'm potentially duplicating things, but I want to make sure everything is covered ;)

At http://docs.sublimetext.info/en/latest/reference/build_systems/exec.html, it mentions the syntax key, with the text Optional. If provided, it will be used to colorize the build system’s output.

I think it would be useful to mention that it accepts values like scope:source.js as well as a path to the syntax definition file Packages/JavaScript/JSON.sublime-syntax, and its default as per https://forum.sublimetext.com/t/new-build-system-syntax-option/14953/2

Thanks :)

Once a user creates a .sublime-build file, what do they do with it?? This should be explained somewhere in sublime-undocs/source/reference/build_systems/basics.rst

No idea why source.python means anything to sublime, nor how to provide more specific selectors, a link to a full explanation[another doc page?] would be do well here.

This doesn't seem to work:

https://github.com/guillermooo/sublime-undocs/blame/sublime-text-3/source/editing/editing.rst#L55

When I try this I just get the right mouse button menu

Sublime Text 2 does not recognize the keywords env or shell in build systems: http://sublimetext.userecho.com/topic/125307-build-system-should-honor-env-as-documented/

The page https://github.com/SublimeText/UnofficialDocs/blob/master/source/reference/build_systems.rst should be modified accordingly.

Hi,

The command line usage page is very lacking in detail and examples.

I think it would be great to include details on how the --command argument to subl works, as mentioned on the ST3 forums recently - specifically, how to execute multiple commands at once and how to pass arguments (in JSON) to the commands.

For example, it doesn't search <ul> or <li> in a html file, it can search strings with 3 letters or longer like <div> or others.

Is this customizable?

from: https://github.com/FichteFoll/UnofficialDocs/issues/18

I try use $TM_FILENAME in my project but this return null...

Have any way to use this recourse?

I'm currently editing these and thought: Would we want to replace the old JSON definition or provide the old JSON version as a leftover for those who are uncomfortable with YAML? Maybe a simple notice stating that everything is possible using JSON as well would be enough.

The file search_and_replace_files.rst states:

Adding individual directories (Unix-style paths, even on Windows)

It doesn't talk about absolute versus relative paths, though. I believe if I have a project with just one folder C:/x in it, then entering foo/bar means C:/x/foo/bar. It should state this explicitly.

Also, what happens when I have more than one folder in my project?

And if I enter foo/bar, will it find all files under this folder hierarchy? E.g. will it find a file C:/x/foo/bar/a/b.c?

The list with folder options here is missing "follow_symlinks".

(See the Folders heading at https://www.sublimetext.com/docs/3/projects.html)

from: https://github.com/FichteFoll/UnofficialDocs/issues/17

Package Control is a core feature nowadays for downloading, insalling and updating packages/plugins easily. It should be mentioned and explained somewhere in the docs considering that almost every package supports it.

Additionally, I can link to this section for instructions on how to install my packages using PC. ;)

Firstly, Thanks for maintaining such awesome documentation. It's been a great resource.

Currently, Themes are not documented. There is no mention of ".sublime-theme" in the entire documentation.

(now I have no idea what to write)
Please document the same.

The snippets documentation refers to custom variables and states that they can be defined in .sublime-options files. https://github.com/guillermooo/sublime-undocs/blame/8a3b31288b1e329263c65701b5c133dc8755bc27/source/extensibility/snippets.rst#L105

However, there is no other mention of .sublime-options files in the documentation, specifically, what file format they should be. Is this information actually true?

In my experience, custom variables can be defined in tmPreferences files, in the shellVariables dict section. As you know, shellVariables are used to define TM_COMMENT_START and TM_COMMENT_END, which can be used in snippets. Example: https://github.com/sublimehq/Packages/blob/4db940a44b74727ade298927d5ffdb8826fc9769/HTML/Comments.tmPreferences#L14-L16

It therefore stands to reason that other variables can be defined here too. Example/proof:

<?xml version="1.0" encoding="UTF-8"?>
<plist version="1.0">
<dict>
    <key>name</key>
    <string>Comments</string>
    <key>scope</key>
    <string>text.html</string>
    <key>settings</key>
    <dict>
        <key>shellVariables</key>
        <array>
            <dict>
                <key>name</key>
                <string>TM_COMMENT_START</string>
                <key>value</key>
                <string>&lt;!-- </string>
            </dict>
            <dict>
                <key>name</key>
                <string>TM_COMMENT_END</string>
                <key>value</key>
                <string> --&gt;</string>
            </dict>
            <dict>
                <key>name</key>
                <string>HELLO_WORLD</string>
                <key>value</key>
                <string>wow!</string>
            </dict>
        </array>
    </dict>
</dict>
</plist>

Snippet:

<snippet>
    <content><![CDATA[
Hello, ${1:this} is a ${2:snippet}. $HELLO_WORLD
]]></content>
    <!-- Optional: Set a tabTrigger to define how to trigger the snippet -->
    <!-- <tabTrigger>hello</tabTrigger> -->
    <!-- Optional: Set a scope to limit where the snippet will trigger -->
    <!-- <scope>source.python</scope> -->
</snippet>

Output when inserting snippet in a HTML file:

Hello, this is a snippet. wow!

Therefore, please can the documentation be updated to reflect the facts.

(comment "escaped" by @FichteFoll, for the curious)

<html lang="en">
  <head>
    <meta name="google-signin-scope" content="profile email">
    <meta name="google-signin-client_id" content="YOUR_CLIENT_ID.apps.googleusercontent.com">
    <script src="https://apis.google.com/js/platform.js" async defer></script>
  </head>
  <body>
    <div class="g-signin2" data-onsuccess="onSignIn" data-theme="dark"></div>
    <script>
      function onSignIn(googleUser) {
        // Useful data for your client-side scripts:
        var profile = googleUser.getBasicProfile();
        console.log("ID: " + profile.getId()); // Don't send this directly to your server!
        console.log("Name: " + profile.getName());
        console.log("Image URL: " + profile.getImageUrl());
        console.log("Email: " + profile.getEmail());

        // The ID token you need to pass to your backend:
        var id_token = googleUser.getAuthResponse().id_token;
        console.log("ID Token: " + id_token);
      };
    </script>
  </body>
</html>

Whereas Windows and OSX use Ctrl + Spacebar as a completion shortcut, Linux shortcut is set to Alt+/ by default :

    { "keys": ["alt+/"], "command": "auto_complete" },
    { "keys": ["alt+/"], "command": "replace_completion_with_auto_complete", "context":
        [
            { "key": "last_command", "operator": "equal", "operand": "insert_best_completion" },
            { "key": "auto_complete_visible", "operator": "equal", "operand": false },
            { "key": "setting.tab_completion", "operator": "equal", "operand": true }
        ]
    },

This behaviour should be addressed on the "Completion" page.

Building system

{
"cmd": ["TASM", "$file_name"],
"cmd": ["TLINK", "/t", "$file_base_name.OBJ"],
"selector": "source.asm"
}

first line is not executing
second line, the TLINK needs a file created by TASM
but it gives me error that file not exist (really not exist)
if i put thoose two on different build systems
and run them consecutively it works

this problem have a solution?
thx in advance!

The key symbols being used on the Editing page, specifically the content under Column Selection, to wit the Shift key ⇧, Command key ⌘, and Option key ⌥ are quite difficult to discern as they appear on Read The Docs.

Is there any way you could make them a bit larger, or apply title text to them? Or if necessary, change them to words?

I've been on a programming/development hiatus for a year plus and am not up to speed on a bunch of things, so please forgive me if this has already been discussed, but what is the status of the unofficial docs at this point? I was just browsing through the official documentation and was pretty impressed with the couple of pages I glanced at, so is this project irrelevant at this point? It doesn't look like there's been a whole lot of action recently, and there are still some pretty glaring issues and omissions:

• popups, minihtml, and CSS styling not even mentioned — view.show_popup() was added in build 3070 (released 17 Feb 2015)
• new .sublime-color-scheme format
• lots of API changes
• build system changes and error highlighting
• new settings options
• theming enhancements

and probably a bunch more. I don't have the time ATM to check if all the API functions in the "Missing in the official docs" section have since been added (at least sublime.Window.set_layout() has not), so that section may still be useful, but at least according to this issue the "undocumented API" may be that way for a reason and subject to change or deletion at any time - @FichteFoll could you add any clarity to that?

So, does this project still have a raison d'être, or should it be clearly marked in the header of every page as containing potentially obsolete information and direct visitors to the official docs?

The paragraph:

"On OS X, the system Python is used instead. Modifying your system version of Python, such as replacing it with the MacPorts version, can cause problems for Sublime Text."

is inaccurate.

On ST3 Build 3047 the Python used is on /Applications/Sublime Text.app/Contents/MacOS/python3.3.zip

As visible by executing print(sys.path) in the console.

Hi,

I realize this documentation isn't maintained at the moment, but thought I would log this for people that are interested.

The text at http://docs.sublimetext.info/en/latest/reference/color_schemes.html#shadow isn't very descriptive.

It seems that the shadow is visible when the text in the document is wider than the window, and will appear on the left and/or the right, depending whether the view can be scrolled to the left or the right.

Also, there is a typo at shadowWidth

Width ot the shadow effect when the buffer is scrolled.

and setting it like this:

<key>shadowWidth</key>
<string>42</string>

seems to remove the shadow altogether, so maybe some example values could be provided? Otherwise it seems that the shadow only appears when this key doesn't exist in the tmTheme file.

I'm still new to mac osx here and I for the life of me can't find it on my own or on google where I go to edit those files. How do I find them so I can edit my completions? Sorry if this is a basic question.

Quick notes from $packages/Default/Main.sublime-menu:

• platform names: OSX, Linux, Windows.
• supports negation: !OSX means not for OSX

Hi, i wanted to know is their such function to search trough pinned files or search for a file in pinned files?

Maybe you guys know a plugin?

The Settings Reference documentation on auto_indent talks about what happens when the user presses "Enter", but auto_indent has some other behavior: when the user presses "Tab" on an empty line, the default keybinding replaces it with the "Reindent" command.

I'm mostly just entering this issue because I want the information to be online somewhere. (I don't know why it does this.)

Please anything know what is the font family of screenshot?

cc @FichteFoll

I think we can get rid of this one?

https://github.com/guillermooo/sublime-undocs/tree/old_fixes

NOTE: Sublime Text 3

There are no default key bindings to toggle the following options in the various find/replace panels. Nor are there documented commands for them anywhere at all that I could find, with the exception of the toggle_in_selection command which is mentioned in the ST forums.

• Toggle Wrap
• Toggle In Selection
• Toggle Highlight Matches
• Toggle Show Context (find/replace in files only)
• Toggle Use Buffer (find/replace in files only)

Today I had a play around with guessing the command names and managed to find them all quite easily with a little trial-and-error.

Find/Replace Panel Options - Not Documented Anywhere AFAICT
-----------------------------------------------------------
Toggle Wrap:               Command: toggle_wrap
Toggle In Selection:       Command: toggle_in_selection
Toggle Highlight Matches:  Command: toggle_highlight
Toggle Show Context:       Command: toggle_show_context
Toggle Use Buffer:         Command: toggle_use_buffer

The rest (below) all already have key bindings in the default key bindings files:

Find/Replace Panel Options
--------------------------
Toggle Regex:              Command: toggle_regex
Toggle Case Sensitive:     Command: toggle_case_sensitive
Toggle Whole Word:         Command: toggle_whole_word
Toggle Preserve Case:      Command: toggle_preserve_case

None of these at all are documented in the Sublime Text Unofficial Documentation. I think someone should add them all along with an example key binding showing how to set them up to work within the context of the find/replace panels which is done like this.

{ "keys": ["alt+h"], "command": "toggle_highlight", "context":
    [
        { "key": "setting.is_widget", "operator": "equal", "operand": true }
    ]
},

I have posted them in a post on the Sublime Text forum.

Hope this helps.

In commands, it seems that prompt_select_project was replaced by prompt_select_workspace

Can be found here: https://docs.sublimetext.info/en/latest/reference/commands.html?highlight=prompt_select_project
Reference: https://forum.sublimetext.com/t/sublime-text-3-build-3103-shortcut-lost/17498

The documentation on metadata/tmPreferences files (http://docs.sublimetext.info/en/latest/reference/metadata.html) doesn't mention the preserveIndent setting.

As an example, this setting is currently (true as of build 3118) set to true in the Default package Indentation Rules - Comments.tmPreferences file, for the comment scope. More info here: sublimehq/sublime_text#1271 (comment)