Comments (10)
@aseaday But the syntax is exactly what's missing. We already have a long and thorough readme with links to further information. We just don't know how to write a program with this programming language.
from markovjunior.
I have started writing about xml syntax in syntax.md. Hope this helps!
from markovjunior.
The node factory is a good place to start, These will be your toplevel elements.
Lines 24 to 38 in 222cd2e
Each node has a Load
method which should help deduce what nested elements the node is expecting.
from markovjunior.
I'm trying to write xsd
definitions for xml files.
It looks like VS can automatically load the xsd
and display popups.
Of course it is also important to write human-readable documentation.
Some attempts (remarks may not be accurate):
models.xsd
put this at docs/models.xsd
<?xml version="1.0" encoding="utf-8" ?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:element name="models">
<xs:complexType mixed="true">
<xs:sequence>
<xs:element name="model" maxOccurs="unbounded">
<xs:complexType>
<xs:attribute name="name" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>Model xml file name.
File `$"models/{name}.xml"` should exist.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="size" default="-1" type="xs:int" use="optional">
<xs:annotation>
<xs:documentation>Output Size in Pixel. default=-1
Note: If `size` is not specified, then `widht` and `hight` should be specified.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="d" default="2" use="optional">
<xs:annotation>
<xs:documentation>Output dimension. [2, 3] default=2</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:positiveInteger">
<xs:enumeration value="2" />
<xs:enumeration value="3" />
</xs:restriction>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="length" type="xs:positiveInteger" use="optional">
<xs:annotation>
<xs:documentation>X-axis length. default=size</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="width" type="xs:positiveInteger" use="optional">
<xs:annotation>
<xs:documentation>Y-axis width. default=size</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="height" type="xs:positiveInteger" use="optional">
<xs:annotation>
<xs:documentation>Z-axis height.
2D (d==2), default=1;
3D (d==3), default=size;
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="amount" default="2" type="xs:positiveInteger" use="optional">
<xs:annotation>
<xs:documentation>Number of output files. default=2</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="pixelsize" default="4" type="xs:positiveInteger" use="optional">
<xs:annotation>
<xs:documentation>Pixel point size. default=4</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="seeds" default="null" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>Random number seed list. default=null</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="gif" default="false" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>Whether to output gifs. default=false</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="iso" default="false" type="xs:boolean" use="optional">
<xs:annotation>
<xs:documentation>Whether to output in `iso` format. default=false</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="steps" default="1000" type="xs:int" use="optional">
<xs:annotation>
<xs:documentation>Number of rule execution steps.
GIF (gif==true), default=1000;
Others (gif==false), default=50000;</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="gui" default="0" type="xs:nonNegativeInteger" use="optional">
<xs:annotation>
<xs:documentation>The width of the graphical rule sidebar in the output image.
default=0 (not show)</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:schema>
from markovjunior.
Hi, I am working on a port of Markov Junior project. And I am considering to create a doc for this project. What syntax doc format do you prefer or recommend?
from markovjunior.
@aseaday It's supposed to be a programming language, so we need a description of how to write a program with it. What are the keywords and how does the control flow work? I'd just start with a markdown file, because that is the most accessible format.
from markovjunior.
from markovjunior.
How about Gitbook.
I would recommend GitHub pages.
We can write some md documentation first and then decide how to deploy it.
from markovjunior.
How about we talk in Documentation and resources #24.
I think we could formally do this thing as a team.
from markovjunior.
@aseaday But the syntax is exactly what's missing. We already have a long and thorough readme with links to further information. We just don't know how to write a program with this programming language.
I got you. The explanation of node type and there combination rule is missing.
from markovjunior.
Related Issues (20)
- How to run on Linux HOT 11
- Customizability of models? HOT 2
- FileNotFoundException when run from other root path
- The type initializer for 'GUI' threw an exception HOT 2
- Open up GitHub discussions HOT 1
- Any Unity usage example in the future? HOT 1
- Build failed with step as 'How to build' section HOT 2
- Is it possible to define the probability of rules in one node? HOT 1
- The intro page does not explain how MJ start running when there's no rule matched at the first place HOT 2
- Document Probability Attribute HOT 1
- Are there command line arguments or a UI? HOT 2
- map doesn't work with GUI HOT 1
- Symmetry issue (or missunderstanding) HOT 3
- Question about MarkovNode nesting and union. HOT 2
- linux version HOT 2
- The .exe file won't run HOT 3
- Constraint HOT 1
- What to do after building? HOT 7
- This is turing complete HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from markovjunior.