ref/cite completion: fixes and enhancements

Default (Linux).sublime-keymap

@@ -41,6 +41,24 @@ LaTeX Package keymap for Linux
 			{"key": "selector", "operator": "equal", "operand": "text.tex.latex"}],
 		"command": "latex_ref_cite"},
 
+	{	"keys": ["{"],
+		"context":  [
+			{"key": "setting.disable_latex_ref_cite_auto_trigger", "operator": "not_equal", "operand": true},
+			{"key": "selector", "operator": "equal", "operand": "text.tex.latex"},
+			{"key": "selection_empty", "operator": "equal", "operand": true, "match_all": true},
+			{"key": "preceding_text", "operator": "regex_contains",
+				"operand": "\\\\(((eq|page|v|V|auto|name|c|C|cpage)?ref)|(cite([a-zX*]*?)(\\[.*?\\]){0,2}))$", "match_all": true}],
+		"command": "latex_ref_cite", "args": {"insert_char": "{"}},
+
+	{	"keys": [","],
+		"context":  [
+			{"key": "setting.disable_latex_ref_cite_auto_trigger", "operator": "not_equal", "operand": true},
+			{"key": "selector", "operator": "equal", "operand": "text.tex.latex"},
+			{"key": "selection_empty", "operator": "equal", "operand": true, "match_all": true},
+			{"key": "preceding_text", "operator": "regex_contains",
+				"operand": "\\\\cite([a-zX*]*?)(\\[.*?\\]){0,2}\\{(?:[^{},]*,)*[^{},]+$", "match_all": true}],
+		"command": "latex_ref_cite", "args": {"insert_char": ","}},
+
 
 	// View PDF, jump to point, toggle editor/viewer focus and syncing behavior
 	{ 	"keys": ["ctrl+l","v"],

Default (OSX).sublime-keymap

@@ -41,6 +41,24 @@ LaTeX Package keymap for OS X
 			{"key": "selector", "operator": "equal", "operand": "text.tex.latex"}],
 		"command": "latex_ref_cite"},
 
+	{	"keys": ["{"],
+		"context":  [
+			{"key": "setting.disable_latex_ref_cite_auto_trigger", "operator": "not_equal", "operand": true},
+			{"key": "selector", "operator": "equal", "operand": "text.tex.latex"},
+			{"key": "selection_empty", "operator": "equal", "operand": true, "match_all": true},
+			{"key": "preceding_text", "operator": "regex_contains",
+				"operand": "\\\\(((eq|page|v|V|auto|name|c|C|cpage)?ref)|(cite([a-zX*]*?)(\\[.*?\\]){0,2}))$", "match_all": true}],
+		"command": "latex_ref_cite", "args": {"insert_char": "{"}},
+
+	{	"keys": [","],
+		"context":  [
+			{"key": "setting.disable_latex_ref_cite_auto_trigger", "operator": "not_equal", "operand": true},
+			{"key": "selector", "operator": "equal", "operand": "text.tex.latex"},
+			{"key": "selection_empty", "operator": "equal", "operand": true, "match_all": true},
+			{"key": "preceding_text", "operator": "regex_contains",
+				"operand": "\\\\cite([a-zX*]*?)(\\[.*?\\]){0,2}\\{(?:[^{},]*,)*[^{},]+$", "match_all": true}],
+		"command": "latex_ref_cite", "args": {"insert_char": ","}},
+
 	// View PDF, jump to point, toggle editor/viewer focus
 	{ 	"keys": ["super+l","v"],
 		"context":  [

Default (Windows).sublime-keymap

@@ -41,6 +41,24 @@ LaTeX Package keymap for Windows
 			{"key": "selector", "operator": "equal", "operand": "text.tex.latex"}],
 		"command": "latex_ref_cite"},
 
+	{	"keys": ["{"],
+		"context":  [
+			{"key": "setting.disable_latex_ref_cite_auto_trigger", "operator": "not_equal", "operand": true},
+			{"key": "selector", "operator": "equal", "operand": "text.tex.latex"},
+			{"key": "selection_empty", "operator": "equal", "operand": true, "match_all": true},
+			{"key": "preceding_text", "operator": "regex_contains",
+				"operand": "\\\\(((eq|page|v|V|auto|name|c|C|cpage)?ref)|(cite([a-zX*]*?)(\\[.*?\\]){0,2}))$", "match_all": true}],
+		"command": "latex_ref_cite", "args": {"insert_char": "{"}},
+
+	{	"keys": [","],
+		"context":  [
+			{"key": "setting.disable_latex_ref_cite_auto_trigger", "operator": "not_equal", "operand": true},
+			{"key": "selector", "operator": "equal", "operand": "text.tex.latex"},
+			{"key": "selection_empty", "operator": "equal", "operand": true, "match_all": true},
+			{"key": "preceding_text", "operator": "regex_contains",
+				"operand": "\\\\cite([a-zX*]*?)(\\[.*?\\]){0,2}\\{(?:[^{},]*,)*[^{},]+$", "match_all": true}],
+		"command": "latex_ref_cite", "args": {"insert_char": ","}},
+
 	// View PDF, jump to point, toggle editor/viewer focus
 	{ 	"keys": ["ctrl+l","v"],
 		"context":  [

LaTeXTools Preferences.sublime-settings

@@ -9,6 +9,31 @@
 	// Sync PDF to current editor position after building (true) or not 
 	"forward_sync":	true,
 
+	// Formating of references in quick panel
+	/* This preference sets the format of the quick panel to select citations using wildcards.
+	The setting is a list with one or two string using wildcards for author, title, keyword etc. 
+
+	Default setting: `["{title} ({keyword})","{author}"]` 
+	Format:
+	Can quantum-mechanical description of physical reality be considered complete? This is an non-existing subtitle to illustrate (einstein1935quantum)
+	Albert Einstein and B Podolsky and N Rosen
+
+	Alternative: ["{author_short} {year} - {title_short} ({keyword})","{title}"]
+	Format:
+	Einstein et al. 1935 - Can quantum-mechanical description of physical reality be considered complete (einstein1935quantum)
+	Can quantum-mechanical description of physical reality be considered complete? This is an non-existing subtitle to illustrate
+
+	Alternative: ["{author_short} {year} ({keyword})"]
+	Format:
+	Einstein et al. 1935 (einstein1935quantum)
+
+	Valid wildcards: keyword, title, author, year, author_short, title_short
+	*/
+	"cite_panel_format": ["{author_short} {year} - {title_short} ({keyword})","{title}"],
+
+	// Similarly, the formatting for the autocomplete panel:
+	"cite_autocomplete_format": "{keyword}: {title}",
+
 	// Settings that are specific to Linux platforms
 	"linux": {
 		// Command to invoke Python 2. Useful if you have both Python 2 and Python 3 on your system,

getTeXRoot.py

@@ -2,7 +2,8 @@
 
 # Parse magic comments to retrieve TEX root
 # Stops searching for magic comments at first non-comment line of file
-# Returns root file or current file
+# Returns root file or current file or None (if there is no root file,
+# and the current buffer is an unnamed unsaved file)
 
 # Contributed by Sam Finn
 
@@ -17,9 +18,23 @@ def get_tex_root(view):
 
 
 	texFile = view.file_name()
-	for line in open(texFile, "rU").readlines():
+	root = texFile
+	if texFile is None:
+		# We are in an unnamed, unsaved file.
+		# Read from the buffer instead.
+		if view.substr(0) != '%':
+			return None
+		reg = view.find(r"^%[^\n]*(\n%[^\n]*)*", 0)
+		if not reg:
+			return None
+		line_regs = view.lines(reg)
+		lines = map(view.substr, line_regs)
+
+	else:
+		lines = open(texFile, "rU")
+
+	for line in lines:
 		if not line.startswith('%'):
-			root = texFile
 			break
 		else:
 			# We have a comment match; check for a TEX root match
@@ -30,9 +45,14 @@ def get_tex_root(view):
 				# Create TEX root file name
 				# If there is a TEX root path, use it
 				# If the path is not absolute and a src path exists, pre-pend it
-				(texPath, texName) = os.path.split(texFile)
-				(rootPath, rootName) = os.path.split(mroot.group(1))
-				root = os.path.join(texPath,rootPath,rootName)
+				root = mroot.group(1)
+				if not os.path.isabs(root) and texFile is not None:
+					(texPath, texName) = os.path.split(texFile)
+					root = os.path.join(texPath,root)
 				root = os.path.normpath(root)
 				break
+
+	if isinstance(lines, file):
+		lines.close()
+
 	return root