dc_index

Documentation

Index

• Constants
• Variables
• func DocName(media MediaType, id DocId, lg lang.Lang, opts ...NameOpt) string
• func GeneratedPath(l lang.Lang, name string) string
• func SupplementalDocPath(l lang.Lang, name string) string
• func WebDocPath(refPath bool, cat WebCategory, name string, lg lang.Lang) string
• type DocId
• type MediaType
• type NameOpt
  • func CommandName(name string) NameOpt
  • func RefPath(enable bool) NameOpt
• type NameOpts
  • func (z NameOpts) Apply(opts []NameOpt) NameOpts
• type WebCategory

Constants

const (
	GeneratedDocPath = "docs/generated"
)

const (
	WebDocPathRoot = "docs/"
)

Variables

var (
	RootDocs = []DocId{
		DocRootReadme,
		DocRootLicense,
		DocRootBuild,
		DocRootContributing,
		DocRootCodeOfConduct,
		DocRootSecurityAndPrivacy,
	}

	GeneratedDocs = []DocId{
		DocManualChanges,
		DocManualCommand,
		DocSupplementalPathVariables,
		DocSupplementalExperimentalFeature,
		DocSupplementalTroubleshooting,
		DocSupplementalDropboxBusiness,
	}

	WebDocs = []DocId{
		DocRootBuild,
		DocRootContributing,
		DocRootCodeOfConduct,
		DocRootSecurityAndPrivacy,
		DocWebHome,
		DocWebLicense,
		DocManualCommand,
		DocSupplementalPathVariables,
		DocSupplementalExperimentalFeature,
		DocSupplementalTroubleshooting,
		DocSupplementalDropboxBusiness,
	}

	AllMedia = []MediaType{
		MediaRepository,
		MediaWeb,
	}
)

Functions

func DocName

func DocName(media MediaType, id DocId, lg lang.Lang, opts ...NameOpt) string

DocName Document path and name (without extension)

func GeneratedPath

func GeneratedPath(l lang.Lang, name string) string

func SupplementalDocPath

func SupplementalDocPath(l lang.Lang, name string) string

func WebDocPath

func WebDocPath(refPath bool, cat WebCategory, name string, lg lang.Lang) string

Types

type DocId

type DocId int

const (
	DocRootReadme DocId = iota
	DocRootLicense
	DocRootBuild
	DocRootContributing
	DocRootCodeOfConduct
	DocRootSecurityAndPrivacy

	DocWebHome
	DocWebLicense
	DocWebCommandTableOfContent

	// Changes from the previous release
	DocManualChanges
	// Individual manual for each commands
	DocManualCommand

	// Supplemental
	DocSupplementalPathVariables
	DocSupplementalExperimentalFeature
	DocSupplementalTroubleshooting
	DocSupplementalDropboxBusiness
)

type MediaType

type MediaType int

const (
	MediaRepository MediaType = iota
	MediaWeb
)

type NameOpt

type NameOpt func(opts NameOpts) NameOpts

func CommandName

func CommandName(name string) NameOpt

func RefPath

func RefPath(enable bool) NameOpt

type NameOpts

type NameOpts struct {
	CommandName string `json:"command_name"`
	RefPath     bool   `json:"ref_path"`
}

func (NameOpts) Apply

func (z NameOpts) Apply(opts []NameOpt) NameOpts

type WebCategory

type WebCategory int

const (
	WebCategoryHome WebCategory = iota
	WebCategoryCommand
	WebCategoryGuide
)