Page Format

[DeltaDizzy]

We also need to decide how we are going to arrange the wiki pages. The two competing options are the Example/Explanation format (used in the KopernicusExamples pages) and the Table format (used in several of the core Kopernicus pages).

[democat3457]

I think the following format would work as a meld between the two::
Description
This is a sample node that samples and is a subnode of Samples { }.

Example (although example could also go at the end)

Samples
{
  Sample 
  {
    name = Sample1
  }
}

Subnodes

• Sample3 { }
• Banana { }
• LandClasses/Class { }

Table

Property	Format	Description
name	String	The name of the Sample.
enabled	Boolean	Whether this should be enabled.

[DeltaDizzy]

Also in relation to this, we should decide on some formatting standards, such as tabs vs spaces/how many we decide to use, spaces before and after comments, and the like.

[democat3457]

I think a tab should equal 2 spaces in the examples, (so use spaces, not tabs) and when referencing nodes, use Node(space){(space)}

[democat3457]

And what do you mean by comments? In-line comments?

[DeltaDizzy]

key = value // this is what that means

[democat3457]

Oh. I think comments should be styled before the line, like this:

// execute the sample
Sample
{
  // the name of the component
  name = hi // no comments like this
  
  // the class
  Class
  {
    // the name of the class
    name = hi2
  }
}

But that's just me.

[DeltaDizzy]

Well that means there can be ambiguity over whether a comment is for the line below or above it. We could separate values like you show there, but for large numbers of values in a row, that could become unwieldy.

[democat3457]

true... then, instead of putting comments before key/value pairs, put the comments on the same line but keep node comments the same, but with new lines after the node, i.e.,

// node comment
Sample
{
  // Class1
  Class
  {
    name = Class1 // the name of the class
    number = 18005555555 // the destination phone number
  }

  // Class2
  Class
  {
    name = Class2
    disconnected = true // whether the call should be dropped
  }
}

[DeltaDizzy]

Yeah I can do that.