index : linux	frominto-error master
	Contrib clone of linux	matthias

summaryrefslogtreecommitdiffstats

log msg author committer range

path: root/.gitattributes

Age	Commit message (Expand)	Author
2016-10-07	.gitattributes: set git diff driver for C source code files	Jean Delvare

generated by cgit v1.2.3 (git 2.25.1) at 2024-08-09 16:26:03 +0000

package main

import (
	"strings"
)

// GenerateSetCommandHelpSections generates help documentation for the set command
func GenerateSetCommandHelpSections(config Config) (helpSections []*HelpSection) {
	description := []HelpSectionText{
		{text: "set", themeComponentID: CmpHelpViewSectionSubTitle},
		{},
		{text: "The set command allows configuration variables to be set. It has the form:"},
		{},
		{text: "set variable value", themeComponentID: CmpHelpViewSectionCodeBlock},
		{},
		{text: "For example, to set the tab width to tab width to 4, the currently active theme to \"mytheme\" and enable mouse support:"},
		{},
		{text: "set tabwidth 4", themeComponentID: CmpHelpViewSectionCodeBlock},
		{text: "set theme mytheme", themeComponentID: CmpHelpViewSectionCodeBlock},
		{text: "set mouse true", themeComponentID: CmpHelpViewSectionCodeBlock},
		{},
		{text: "GRV currently has the following themes available:"},
		{},
		{text: " - solarized"},
		{text: " - classic"},
		{text: " - cold"},
		{},
		{text: "The solarized theme is the default theme for GRV and does not respect the terminals colour palette."},
		{text: "The classic and cold themes do respect the terminals colour palette."},
	}

	return []*HelpSection{
		{
			description: description,
		},
	}
}

// GenerateThemeCommandHelpSections generates help documentation for the theme command
func GenerateThemeCommandHelpSections(config Config) (helpSections []*HelpSection) {
	description := []HelpSectionText{
		{text: "theme", themeComponentID: CmpHelpViewSectionSubTitle},
		{},
		{text: "The theme command allows a custom theme to be defined."},
		{text: "This theme can then be activated using the theme config variable described above."},
		{text: "The form of the theme command is:"},
		{},
		{text: "theme --name [ThemeName] --component [ComponentId] --bgcolor [BackgroundColor] --fgcolor [ForegroundColor]", themeComponentID: CmpHelpViewSectionCodeBlock},
		{},
		{text: " - ThemeName: The name of the theme to be created/updated."},
		{text: " - ComponentId: The Id of the screen component (the part of the display to change)."},
		{text: " - BackgroundColor: The background color."},
		{text: " - ForegroundColor: The foreground color."},
		{},
		{text: "Using a sequence of theme commands it is possible to define a theme."},
		{text: "For example, to define a new theme \"mytheme\" and set it as the active theme:"},
		{},
		{text: "theme --name mytheme --component CommitView.Date      --bgcolor None --fgcolor Red", themeComponentID: CmpHelpViewSectionCodeBlock},
		{text: "theme --name mytheme --component RefView.Tag          --bgcolor Blue --fgcolor 36", themeComponentID: CmpHelpViewSectionCodeBlock},
		{text: "theme --name mytheme --component StatusBarView.Normal --bgcolor None --fgcolor f14a98", themeComponentID: CmpHelpViewSectionCodeBlock},
		{text: "set theme mytheme", themeComponentID: CmpHelpViewSectionCodeBlock},
		{},
		{text: "GRV supports 256 colors (when available). Provided colors will be mapped to the nearest available color."},
		{text: "The allowed color values are:"},
		{},
		{text: "System colors:"},
		{},
		{text: "None", themeComponentID: CmpHelpViewSectionCodeBlock},
		{text: "Black", themeComponentID: CmpHelpViewSectionCodeBlock},
		{text: "Red", themeComponentID: CmpHelpViewSectionCodeBlock},
		{text: "Green", themeComponentID: CmpHelpViewSectionCodeBlock},
		{text: "Yellow", themeComponentID: CmpHelpViewSectionCodeBlock},
		{text: "Blue", themeComponentID: CmpHelpViewSectionCodeBlock},
		{text: "Magenta", themeComponentID: CmpHelpViewSectionCodeBlock},
		{text: "Cyan", themeComponentID: CmpHelpViewSectionCodeBlock},
		{text: "White", themeComponentID: CmpHelpViewSectionCodeBlock},
		{},
		{text: "Terminal Color Numbers:"},
		{},
		{text: "0 - 255", themeComponentID: CmpHelpViewSectionCodeBlock},
		{},
		{text: "Hex Colors:"},
		{},
		{text: "000000 - ffffff", themeComponentID: CmpHelpViewSectionCodeBlock},
		{},
		{text: "The set of screen components that can be customised is:"},
		{},
	}

	var prevPrefix string
	for _, themeComponent := range ThemeComponentNames() {
		prefix := strings.Split(themeComponent, ".")[0]

		if prevPrefix != "" && prevPrefix != prefix {
			description = append(description, HelpSectionText{themeComponentID: CmpHelpViewSectionCodeBlock})
		}

		prevPrefix = prefix
		description = append(description, HelpSectionText{text: themeComponent, themeComponentID: CmpHelpViewSectionCodeBlock})
	}

	return []*HelpSection{
		{
			description: description,
		},
	}
}

// GenerateMapCommandHelpSections generates help documentation for the map command
func GenerateMapCommandHelpSections(config Config) (helpSections []*HelpSection) {
	description := []HelpSectionText{
		{text: "map", themeComponentID: CmpHelpViewSectionSubTitle},
		{},
		{text: "The map command allows a key sequence to be mapped to an action, another key sequence or a shell command for a specified view."},
		{text: "The form of the map command is:"},
		{},
		{text: "map view fromkeys tokeys", themeComponentID: CmpHelpViewSectionCodeBlock},
		{},
		{text: "For example, to map the key 'a' to the keys 'gg' in the Ref View:"},
		{},
		{text: "map RefView a gg", themeComponentID: CmpHelpViewSectionCodeBlock},
		{},
		{text: "When pressing 'a' in the Ref View, the first line would then become the selected line, as 'gg' moves the cursor to the first line."},
		{text: "All is a valid view argument when a binding should apply to all views."},
		{},
		{text: "GRV also has a text representation of actions that are independent of key bindings."},
		{text: "For example, the following commands can be used to make the <Up> key move a line down and the <Down> key move a line up:"},
		{},
		{text: "map All <Up> <grv-next-line>", themeComponentID: CmpHelpViewSectionCodeBlock},
		{text: "map All <Down> <grv-prev-line>", themeComponentID: CmpHelpViewSectionCodeBlock},
		{},
		{text: "The map command also allows a key sequence to be mapped directly to a shell command."},
		{text: "Prefix a shell command with the '!' character. For example, to map the key 'a' to the shell command 'ls -lh':"},
		{},
		{text: "map All a !ls -lh", themeComponentID: CmpHelpViewSectionCodeBlock},
		{},
		{text: "The set of actions available is described in the key binding tables above."},
	}

	return []*HelpSection{
		{
			description: description,
		},
	}
}

// GenerateUnmapCommandHelpSections generates help documentation for the unmap command
func GenerateUnmapCommandHelpSections(config Config) (helpSections []*HelpSection) {
	description := []HelpSectionText{
		{text: "unmap", themeComponentID: CmpHelpViewSectionSubTitle},
		{},
		{text: "The unmap command removes any defined key binding for a key sequence in the specified view."},
		{text: "The form of the unmap command is:"},
		{},
		{text: "unmap view fromkeys", themeComponentID: CmpHelpViewSectionCodeBlock},
		{},
		{text: "For example, to unmap the key 'c' in the Ref View:"},
		{},
		{text: "unmap RefView c", themeComponentID: CmpHelpViewSectionCodeBlock},
	}

	return []*HelpSection{
		{
			description: description,
		},
	}
}

// GenerateQuitCommandHelpSections generates help documentation for the quit command
func GenerateQuitCommandHelpSections(config Config) (helpSections []*HelpSection) {
	description := []HelpSectionText{
		{text: "q", themeComponentID: CmpHelpViewSectionSubTitle},
		{},
		{text: "The quit command is used to exit GRV and can be used with the following keys:"},
		{},
		{text: ":q<Enter>", themeComponentID: CmpHelpViewSectionCodeBlock},
	}

	return []*HelpSection{
		{
			description: description,
		},
	}
}

// GenerateAddTabCommandHelpSections generates help documentation for the addtab command
func GenerateAddTabCommandHelpSections(config Config) (helpSections []*HelpSection) {
	description := []HelpSectionText{
		{text: "addtab", themeComponentID: CmpHelpViewSectionSubTitle},
		{},
		{text: "The addtab command creates a new named empty tab and switches to this new tab."},
		{text: "The format of the command is:"},
		{},
		{text: "addtab tabname", themeComponentID: CmpHelpViewSectionCodeBlock},
		{},
		{text: "For example, to add a new tab titled \"mycustomtab\" the following command can be used:"},
		{},
		{text: "addtab mycustomtab", themeComponentID: CmpHelpViewSectionCodeBlock},
	}

	return []*HelpSection{
		{
			description: description,
		},
	}
}

// GenerateRmTabCommandHelpSections generates help documentation for the rmtab command
func GenerateRmTabCommandHelpSections(config Config) (helpSections []*HelpSection) {
	description := []HelpSectionText{
		{text: "rmtab", themeComponentID: CmpHelpViewSectionSubTitle},
		{},
		{text: "The rmtab removes the currently active tab. If the tab removed is the last tab then GRV will exit."},
	}

	return []*HelpSection{
		{
			description: description,
		},
	}
}

// GenerateAddViewCommandHelpSections generates help documentation for the addview command
func GenerateAddViewCommandHelpSections(config Config) (helpSections []*HelpSection) {
	description := []HelpSectionText{
		{text: "addview", themeComponentID: CmpHelpViewSectionSubTitle},
		{},
		{text: "The addview command allows a view to be added to the currently active tab."},
		{text: "The form of the command is:"},
		{},
		{text: "addview view viewargs...", themeComponentID: CmpHelpViewSectionCodeBlock},
		{},
		{text: "Each view accepts a different set of arguments. This is described in the table below:"},
	}

	helpSections = append(helpSections, &HelpSection{
		<