jakoubek/feragstring
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updated README

Browse source
This commit is contained in:
Oliver Jakoubek 2020-07-02 18:30:28 +02:00
parent 085ed0c8ad
commit 5f26a3d4c3
1 changed files with 23 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -2,7 +2,7 @@
# feragstring # feragstring
*feragstring* is a Go package for creating a FERAG string file from a JSON data structure. If you don't know what FERAG (the company) or a FERAG string is you probably don't need this package ;-) *feragstring* is a Go package for creating a FERAG string file programmatically. If you don't know what FERAG (the company) or a FERAG string is you probably don't need this package ;-)
## The shortest possible FERAG string ## The shortest possible FERAG string
@ -27,14 +27,17 @@ The variable values are:
## Usage ## Usage
```go ```go
// create a FERAG string object
fs := feragstring.NewFeragString() fs := feragstring.NewFeragString()
fs.SetTitleName("EDITION1") fs.SetTitleName("EDITION1")
// set title parameters
fs.TitleInfo.SetPrintObjectName("EDITION1A") fs.TitleInfo.SetPrintObjectName("EDITION1A")
fs.TitleInfo.SetPublicationDate("2020-05-31") fs.TitleInfo.SetPublicationDate("2020-05-31")
fs.TitleInfo.SetCountryCode("13") fs.TitleInfo.SetCountryCode("13")
fs.TitleInfo.SetPrintObjectColor("00000000") fs.TitleInfo.SetPrintObjectColor("00000000")
// add a product
pr1 := feragstring.NewProductReference() pr1 := feragstring.NewProductReference()
pr1.SetProductName("MAIN") pr1.SetProductName("MAIN")
pr1.SetCopiesAssigned(25000) pr1.SetCopiesAssigned(25000)
@ -45,12 +48,25 @@ pr1.SetMissingParameter(mp)
pr1.SetIssueReference("MAIN01") pr1.SetIssueReference("MAIN01")
fs.AddProductReference(pr1) fs.AddProductReference(pr1)
rl1 := feragstring.NewRouteListEntry() // add a route
rl1.SetRouteName("ROUTE001") rt := feragstring.NewRoute()
rl1.SetRouteCode(fs.NextRouteCode()) rt.SetRouteName("ROUTE001")
rl1.SetRampNumber(0) rt.SetRouteCode(fs.NextRouteCode())
rl1.SetCopiesInRoute(1500) rt.SetRampNumber(0)
fs.AddRouteListEntry(rl1) rt.SetCopiesInRoute(1500)
rt.SetLimit(1)
rt.SetMaxStack(13)
rt.SetStandard(40)
rt.SetParameterN(4)
rt.SetMaxBundle(40)
rt.SetTopsheetMarker(5)
rt.SetEaMarker(0)
rt.SetTopsheetTemplateDirectory(20)
rt.AddProductReferenceNumber(1)
fs.AddRoute(rt)
// get the FERAG string (the write it to a file...)
feragString := fs.PrintOut()
``` ```
## Supported messages ## Supported messages