# Write

go-cff provides two ways to serialize a cff.CFF object as the CFF format:

cff.Save(content Cff) for getting a string back
cff.SaveFile(file string, content Cff) for saving as a file

cff.CFF is a struct, so you can easly create a new object from that struct or extend an already read in object. Empty and not set fields are skipped during serialisation.

# Helper

For providing a better experience, we use special data structures when parsing a file, for example url.URL. However, when creating a field with such a data structure, it is often really messy. Hence, you can use the following helper functions as alegant shortcuts:

content := cff.Cff{
    Version: "1.0",
    Doi:     cff.MakeDoi("10.1038/123456"),
}
content2 := cff.Cff{
    Version: "1.0",
    Doi: cff.DOI{
        RegistrantCode:     "123456",
        General:            "10",
        DirectoryIndicator: "1038",
    },
}
fmt.Println("Equal: ", reflect.DeepEqual(content, content2))

# The `PersonEntity` type

For an exmplenation see Parse.

The construction of a PersonEntity is very simple, use it like this:

cff.Cff{
  Authors: []cff.PersonEntity{
      {
          Person: cff.Person{
              GivenNames: "John",
              Family:     "Doe",
          },
      },
      {
          Entity: cff.Entity{
              Address: "123 Main St",
              Email:   "test@l.de",
          },
      },
  },
}

Only the not empty fields are serialized, so setting Person and Entity at the same time is useless.

# Example

# Save as a string

content := cff.Cff{
    Version: "1.0",
    Url:     cff.MakeUrl("http://www.google.com"),
    Doi:     cff.MakeDoi("10.1038/123456"),
}

cffContent, err := cff.Save(content)
if err != nil {
    fmt.Println("Error: ", err)
}
fmt.Println(string(cffContent))

Results in:

doi: 10.1038/123456
url: http://www.google.com
version: 1.0

# Save as a file