I started some new documentation for project XML, please help

Confidant · February 25, 2020, 4:11pm

Like the title says, I’ve started a revamp of the xml project settings page:

ConfidantCommunications/lime.software/blob/ConfidantCommunications-patch-1/_docs/project-files/xml-format.md

---
title: XML Format
---

## Overview

Usually a simple project file is all you need to build projects using Lime, but it can be extended based on your needs. Here is a reference of what you can do.

### Conditionals

First, every node in the project file format supports `if` and `unless` attributes. These are conditional values to help you customize your build process, based upon a number of values. Here are some of the default values:

 * mobile, desktop or web
 * ios, android, windows, mac, linux or html5
 * cpp, neko, flash or js

You can `<set />` or `<unset />` values for conditional logic:

```xml
<set name="red" />

This file has been truncated. show original

I’ve added what I’ve discerned are some missing tags. I’ve filled in some according to my own knowledge. Please review this and send me a pull request to fill in what’s missing. Once it’s done I will send this as a pull request to the main documentation site.

In particular, I have nothing for the following tags:

echo
error
language
launchImage
launchStoryboard
log
module
output
postbuild
prebuild
preloader
sample
ssl
target
templatePath
unset
undefine

One thing to note: in GitHub it displays a nice expanding interface for the glossary using <details> and <summary> tags. I am not sure if the Lime docs site supports that. Open to suggestions.

Confidant · February 27, 2020, 2:30pm

Cue the crickets. Chirp chirp chirp.

teormech · February 27, 2020, 6:13pm

i’ll try to help you with those tags

Confidant · February 27, 2020, 6:56pm

Thanks Alexander! That would be a big help.

teormech · February 27, 2020, 7:41pm

Here is my Pull Request: https://github.com/ConfidantCommunications/lime.software/pull/1/

Gama11 · February 27, 2020, 8:04pm

While you guys are at it, any interest in creating an XML schema for project.xml to have auto completion in VSCode? https://github.com/haxelime/lime-vscode-extension/issues/55

teormech · February 27, 2020, 8:14pm

That’s interesting idea! i might try, though i don’t use VSCode

Confidant · February 27, 2020, 8:16pm

Merged! @singmajesty please review the pull request.

Confidant · February 27, 2020, 8:18pm

@Gama11 I’m done for now but that’s a good idea.

singmajesty · March 3, 2020, 7:38pm

I’ve merged the changes but it appears to be broken

Help would be appreciated

Confidant · March 3, 2020, 7:40pm

Can do; I was afraid that might happen. I guess I will edit out the expanding part and do another pull request.

Confidant · March 3, 2020, 7:51pm

Okay please review the latest pull request.

singmajesty · March 3, 2020, 8:01pm

Okay that looks better

I’m not sure if it’s best to remove the <> from the titles for each tag, though? Open to other opinions

Confidant · March 3, 2020, 8:07pm

I considered that; IMHO as long as we have the example code under each, this way looks cleanest.