Jenkins build is back to normal : royale-asjs_jsonly #198

[apacheroyaleci]

See 

Royale Doc Table-of-Contents UX (was Re: Royale Documentation Page Layout Proposal)

[Alex Harui]

Breaking out a separate thread on this...

Thinking about this some more, I think I can generate an interactive
control with Jekyll, but I don't know how to make it retain state.  I
think that might require cookies and/or frames.

For example, let's say the TOC looked like:

Welcome
--High Level View
--Features
AS3
MXML
Get Started
--Download
--Hello World

I've already implemented logic in the template to auto-expand the tree to
the document for folks who have direct links.  So, if you do a Google
Search and find the link to the MXML page, when you go to that page, the
ToC will automatically look like:

Welcome
--High Level View
--Features
AS3
---*MXML*
Get Started



If you hit the main doc page, the ToC starts out collapsed so that Get
Started isn't pushed down by a bunch of Welcome sub-topics.  So the ToC
initially looks like:

Welcome
Get Started

Now let's say you expand both Welcome and Get Started so you see:

Welcome
--High Level View
--Features
Get Started
--Download
--Hello World

Then you click on Features.  The logic that opens trees to direct links is
going to cause the ToC to look like:


Welcome
--High Level View
--Features
Get Started

Even though you had expanded "Get Started" it will collapse when going to
the Features page.  That's because, without frames, each page is its own
HTML page.  No state about the ToC is retained or shared.

If folks are ok with that, I can probably get that to work.

Thoughts?
-Alex


On 1/26/18, 2:15 PM, "carlos.rov...@gmail.com on behalf of Carlos Rovira"
 wrote:

>Hi Alex,
>
>2018-01-26 21:40 GMT+01:00 Alex Harui :
>
>>One other thing that might need its own thread:  I don't know of a Jekyll
>> way to get the ToC to be separately interactive where you can click on
>>the
>> expand/collapse graphics and the ToC will act like a Tree control.
>>There
>> might be a way since I'm new to Jekyll.  We could replace the Jekyll
>> generation of the ToC with a Royale app that manages the ToC if we need
>>it
>> to be interactive.  Right now everything is static.
>>
>I think this should me more easy since is widely used. We should
>investigate and hope to find and easy way to create a tree navigation.
>As well, I see github pages docs sites that in publication view gives a
>link to the GitHub .md file to edit it.
>So, in the end the docs should be as easy as so we can setup, edit and
>publish in a blink of an eye.
>We should find the right workflow and how to make a tree easily. Then
>creating and editing should be quick for any of us.
>
>A last thing to take into account is about get the right CSS styles for
>code, and other things so .md will be stylized correctly.
>
>I'll continue investigating
>
>Thanks
>
>Carlos
>
>
>
>
>>
>> Thanks,
>> -Alex
>>
>> On 1/26/18, 12:23 PM, "Piotr Zarzycki" 
>>wrote:
>>
>> >Cool!! :)
>> >
>> >2018-01-26 21:18 GMT+01:00 Carlos Rovira :
>> >
>> >> Hi,
>> >>
>> >> I'm playing with this concept
>> >>
>> >>
>> >>https://na01.safelinks.protection.outlook.com/?url=
>> https%3A%2F%2Froyale.c
>> >>odeoscopic.com%2Fdocumentation-page-example%
>> 2F=02%7C01%7Caharui%40ad
>> >>obe.com%7Cf3e8feca0c3e404e43e308d564fab63d%
>> 7Cfa7b1b5a7b34438794aed2c178de
>> >>cee1%7C0%7C0%7C636525950328547739=vuv%
>> 2BuNsHKOO28vssWcdy2TvL1XdxpTS
>> >>floN8ozx1rMk%3D=0
>> >>
>> >> Here I use:
>> >>
>> >> * The website page header
>> >> * Royale logo white use
>> >> * There's an alternate menu to configure (main website, blog,
>> >>GitHub,...)
>> >> * Search for docs (important)
>> >>
>> >> In content:
>> >>
>> >> * Main page doc title
>> >> * Main doc section content (demo content to show something)
>> >>
>> >> Navigation:
>> >>
>> >> * Menu colapasable (accordion type)
>> >> * Only 2 level
>> >> * Menu content has some of the items I saw here and there, but is
>> >>completly
>> >> demo
>> >>
>> >>
>> >> let me know what do you think
>> >>
>> >> Thanks
>> >>
>> >> --
>> >> Carlos Rovira
>> >>
>> >>https://na01.safelinks.protection.outlook.com/?url=
>> http%3A%2F%2Fabout.me%
>> >>2Fcarlosrovira=02%7C01%7Caharui%40adobe.com%
>> 7Cf3e8feca0c3e404e43e308
>> >>d564fab63d%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%
>> 7C63652595032854773
>> >>9=L0tB1P5SOatX1HpGHJ0F928hc2BNwbtg1OCeuXgo8gE%3D=0
>> >>
>> >
>> >
>> >
>> >--
>> >
>> >Piotr Zarzycki
>> >
>> >Patreon:
>> >*https://na01.safelinks.protection.outlook.com/?url=
>> https%3A%2F%2Fwww.patr
>> >eon.com%2Fpiotrzarzycki=02%7C01%7Caharui%40adobe.com%
>> 7Cf3e8feca0c3e40
>> >4e43e308d564fab63d%7Cfa7b1b5a7b34438794aed2c178de
>> cee1%7C0%7C0%7C6365259503
>> >28547739=X85j16C%2FKJ%2Ff%2FbMOl5O%2BfDDfT%
>> 2Biz9y5mSSBRdhplVKk%3D
>> >served=0
>> >> https%3A%2F%2Fwww.patr
>> >eon.com%2Fpiotrzarzycki=02%7C01%7Caharui%40adobe.com%
>> 7Cf3e8feca0c3e40
>> >4e43e308d564fab63d%7Cfa7b1b5a7b34438794aed2c178de
>> 

Re: Royale Documentation Page Layout Proposal

[Carlos Rovira]

Hi Alex,

2018-01-26 21:40 GMT+01:00 Alex Harui :

> Yes, looks great!  My only thought is whether the red background should
> just be a rectangle or may less height on the right so we can bring the
> first line of text up higher and save more screen space.  IOW, try to fit
> a few more lines of documentation on the screen.
>
>
Right, I use the actual background, but as well though in create one for
this. I'll give it a try.


> Also, what if the title is really long and starts to overrun the right
> side of the image?  I suppose we could try some fancy CSS bitmap operation.
>

I think that's not a problem, if the text is large it will continue in the
next line, and should look ok.

>
> One other thing that might need its own thread:  I don't know of a Jekyll
> way to get the ToC to be separately interactive where you can click on the
> expand/collapse graphics and the ToC will act like a Tree control.  There
> might be a way since I'm new to Jekyll.  We could replace the Jekyll
> generation of the ToC with a Royale app that manages the ToC if we need it
> to be interactive.  Right now everything is static.
>

I think this should me more easy since is widely used. We should
investigate and hope to find and easy way to create a tree navigation.
As well, I see github pages docs sites that in publication view gives a
link to the GitHub .md file to edit it.
So, in the end the docs should be as easy as so we can setup, edit and
publish in a blink of an eye.
We should find the right workflow and how to make a tree easily. Then
creating and editing should be quick for any of us.

A last thing to take into account is about get the right CSS styles for
code, and other things so .md will be stylized correctly.

I'll continue investigating

Thanks

Carlos




>
> Thanks,
> -Alex
>
> On 1/26/18, 12:23 PM, "Piotr Zarzycki"  wrote:
>
> >Cool!! :)
> >
> >2018-01-26 21:18 GMT+01:00 Carlos Rovira :
> >
> >> Hi,
> >>
> >> I'm playing with this concept
> >>
> >>
> >>https://na01.safelinks.protection.outlook.com/?url=
> https%3A%2F%2Froyale.c
> >>odeoscopic.com%2Fdocumentation-page-example%
> 2F=02%7C01%7Caharui%40ad
> >>obe.com%7Cf3e8feca0c3e404e43e308d564fab63d%
> 7Cfa7b1b5a7b34438794aed2c178de
> >>cee1%7C0%7C0%7C636525950328547739=vuv%
> 2BuNsHKOO28vssWcdy2TvL1XdxpTS
> >>floN8ozx1rMk%3D=0
> >>
> >> Here I use:
> >>
> >> * The website page header
> >> * Royale logo white use
> >> * There's an alternate menu to configure (main website, blog,
> >>GitHub,...)
> >> * Search for docs (important)
> >>
> >> In content:
> >>
> >> * Main page doc title
> >> * Main doc section content (demo content to show something)
> >>
> >> Navigation:
> >>
> >> * Menu colapasable (accordion type)
> >> * Only 2 level
> >> * Menu content has some of the items I saw here and there, but is
> >>completly
> >> demo
> >>
> >>
> >> let me know what do you think
> >>
> >> Thanks
> >>
> >> --
> >> Carlos Rovira
> >>
> >>https://na01.safelinks.protection.outlook.com/?url=
> http%3A%2F%2Fabout.me%
> >>2Fcarlosrovira=02%7C01%7Caharui%40adobe.com%
> 7Cf3e8feca0c3e404e43e308
> >>d564fab63d%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%
> 7C63652595032854773
> >>9=L0tB1P5SOatX1HpGHJ0F928hc2BNwbtg1OCeuXgo8gE%3D=0
> >>
> >
> >
> >
> >--
> >
> >Piotr Zarzycki
> >
> >Patreon:
> >*https://na01.safelinks.protection.outlook.com/?url=
> https%3A%2F%2Fwww.patr
> >eon.com%2Fpiotrzarzycki=02%7C01%7Caharui%40adobe.com%
> 7Cf3e8feca0c3e40
> >4e43e308d564fab63d%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0%7C0%7C6365259503
> >28547739=X85j16C%2FKJ%2Ff%2FbMOl5O%2BfDDfT%
> 2Biz9y5mSSBRdhplVKk%3D
> >served=0
> > https%3A%2F%2Fwww.patr
> >eon.com%2Fpiotrzarzycki=02%7C01%7Caharui%40adobe.com%
> 7Cf3e8feca0c3e40
> >4e43e308d564fab63d%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0%7C0%7C6365259503
> >28547739=X85j16C%2FKJ%2Ff%2FbMOl5O%2BfDDfT%
> 2Biz9y5mSSBRdhplVKk%3D
> >served=0>*
>
>


-- 
Carlos Rovira
http://about.me/carlosrovira

Re: Royale Documentation Page Layout Proposal

[Alex Harui]

Yes, looks great!  My only thought is whether the red background should
just be a rectangle or may less height on the right so we can bring the
first line of text up higher and save more screen space.  IOW, try to fit
a few more lines of documentation on the screen.

Also, what if the title is really long and starts to overrun the right
side of the image?  I suppose we could try some fancy CSS bitmap operation.

One other thing that might need its own thread:  I don't know of a Jekyll
way to get the ToC to be separately interactive where you can click on the
expand/collapse graphics and the ToC will act like a Tree control.  There
might be a way since I'm new to Jekyll.  We could replace the Jekyll
generation of the ToC with a Royale app that manages the ToC if we need it
to be interactive.  Right now everything is static.

Thanks,
-Alex

On 1/26/18, 12:23 PM, "Piotr Zarzycki"  wrote:

>Cool!! :)
>
>2018-01-26 21:18 GMT+01:00 Carlos Rovira :
>
>> Hi,
>>
>> I'm playing with this concept
>>
>> 
>>https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Froyale.c
>>odeoscopic.com%2Fdocumentation-page-example%2F=02%7C01%7Caharui%40ad
>>obe.com%7Cf3e8feca0c3e404e43e308d564fab63d%7Cfa7b1b5a7b34438794aed2c178de
>>cee1%7C0%7C0%7C636525950328547739=vuv%2BuNsHKOO28vssWcdy2TvL1XdxpTS
>>floN8ozx1rMk%3D=0
>>
>> Here I use:
>>
>> * The website page header
>> * Royale logo white use
>> * There's an alternate menu to configure (main website, blog,
>>GitHub,...)
>> * Search for docs (important)
>>
>> In content:
>>
>> * Main page doc title
>> * Main doc section content (demo content to show something)
>>
>> Navigation:
>>
>> * Menu colapasable (accordion type)
>> * Only 2 level
>> * Menu content has some of the items I saw here and there, but is
>>completly
>> demo
>>
>>
>> let me know what do you think
>>
>> Thanks
>>
>> --
>> Carlos Rovira
>> 
>>https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fabout.me%
>>2Fcarlosrovira=02%7C01%7Caharui%40adobe.com%7Cf3e8feca0c3e404e43e308
>>d564fab63d%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C63652595032854773
>>9=L0tB1P5SOatX1HpGHJ0F928hc2BNwbtg1OCeuXgo8gE%3D=0
>>
>
>
>
>-- 
>
>Piotr Zarzycki
>
>Patreon: 
>*https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.patr
>eon.com%2Fpiotrzarzycki=02%7C01%7Caharui%40adobe.com%7Cf3e8feca0c3e40
>4e43e308d564fab63d%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C6365259503
>28547739=X85j16C%2FKJ%2Ff%2FbMOl5O%2BfDDfT%2Biz9y5mSSBRdhplVKk%3D
>served=0
>eon.com%2Fpiotrzarzycki=02%7C01%7Caharui%40adobe.com%7Cf3e8feca0c3e40
>4e43e308d564fab63d%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C6365259503
>28547739=X85j16C%2FKJ%2Ff%2FbMOl5O%2BfDDfT%2Biz9y5mSSBRdhplVKk%3D
>served=0>*

Re: help text and background image

[Andrew Wetmore]

I am cool with it for now as my main activity is input, not reading.

On Fri, Jan 26, 2018 at 4:30 PM, Alex Harui 
wrote:

> Yep.  I'm waiting for Carlos's input on what the doc screens really should
> look like.  Part of me is tempted to try CSS Regions and get the text to
> flow around the device.  If it is driving you crazy, just remove the
> background-image from the .css file.
>
> HTH,
> -Alex
>
> On 1/26/18, 11:35 AM, "Andrew Wetmore"  wrote:
>
> >Hi:
> >
> >If you look at a help doc page that has a bunch of text, like "Migrate
> >from
> >Flex" [1], the background image renders the text on the right of the
> >screen
> >almost unreadable.
> >
> >[1]
> >https://na01.safelinks.protection.outlook.com/?url=
> http%3A%2F%2Fapacheroya
> >leci.westus2.cloudapp.azure.com%3A8080%2Fjob%2FRoyaleDocs_
> Staging%2FlastSu
> >ccessfulBuild%2Fartifact%2F_site%2Fcreate-an-application%
> 2Fmigrate-an-exis
> >ting-app%2Fmigrate-from-flex.html=02%7C01%7Caharui%40adobe.com
> %7Ca709
> >ffc73e254aca99d508d564f3e857%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0%7C0%7C
> >636525921119798379=2fJoJAHbLDgay5NpwWBSKob0j%
> 2B9MqHC%2B4rp9OTqlJh0%3
> >D=0
> >
> >
> >==
> >Andrew Wetmore
> >
> >https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fcottage14
> .
> >blogspot.com%2F=02%7C01%7Caharui%40adobe.com%
> 7Ca709ffc73e254aca99d508
> >d564f3e857%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%
> 7C636525921119798379
> >=rS%2Fzv10h021hMY6v%2BGJumczpCkGFQFwJOKQTXFny8T4%3D=0
>
>


-- 
Andrew Wetmore

http://cottage14.blogspot.com/

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

[Alex Harui]

On 1/26/18, 11:43 AM, "Andrew Wetmore"  wrote:

>I don't think we need to build out the full ToC up front, rather than PAYG
>haha. There are tons of pages that I have not yet listed in the Google
>doc,
>and several decisions we have to make.
>
>For example, we have an Express set of controls and MDL and who knows what
>else. I presume we need to explain how these various sets of controls
>relate to each other...

Yes, and it also occurred to me that we need to discuss targets (SWF
output and/or JS output) and how to manage that.  And keep in mind that
someday there may be a third or fourth output.

My 2 cents,
-Alex
>
>On Fri, Jan 26, 2018 at 1:09 PM, Alex Harui 
>wrote:
>
>> Hi Andrew,
>>
>> Responses in-line.
>>
>> On 1/26/18, 2:48 AM, "Andrew Wetmore"  wrote:
>>
>> >Good morning.
>> >
>> >Least thing first: Does the Apache header absolutely need to be in
>>short
>> >lines with hard line breaks so it takes up so much vertical space in
>>the
>> >file? Please look at test-apache-header.md and see whether the header
>> laid
>> >out on fewer lines and trusting to line wrapping works.
>>
>> I don't know for sure.  There is a header scanning tool that we use and
>>I
>> just tried it and it didn't mind your reformatting, so that's good
>>enough
>> for me.
>> >
>> >I am fine with your suggestions about where "Hello, World" should be
>>and
>> >how "Developing an application" might play out. However, this does
>>raise
>> >the question of whether this sort of help-docs structure is going to
>>have
>> >an index or other means to locate concepts like "data binding" if it is
>> >tucked down in a larger set of instructions about applications rather
>>than
>> >being a entry itself.
>>
>> IMO, the 10-minute tutorial won't go into any serious detail about data
>> binding, so "data binding" would have its own section wherever it makes
>> sense and a link to it from the tutorial.
>> >
>> >I think the doc structure is still highly fluid and that we need to
>>either
>> >hold off on the ToC until we are closer to alpha-release of the
>> >documentation, or have a less-bulky ToC document. My rough estimate is
>> >that
>> >we have stubs for less than 10% of the pages we will eventually have.
>>
>> IMO, the toc.json is relatively compact and much easier to change.  I'm
>> not sure how to make it any smaller.  I could probably sit down and
>>crank
>> out all of the missing stubs in an evening, but is it worth it?  I like
>> the fact that entries don't show up until we create a page for them.
>>
>> My 2 cents,
>> -Alex
>> >
>> >On Fri, Jan 26, 2018 at 4:40 AM, Alex Harui 
>> >wrote:
>> >
>> >> Hi Andrew,
>> >>
>> >> I took a quick peek at the Adobe doc.  I'm not sure "Development
>>Phases"
>> >> should be the first thing under "Create an application", especially
>> >>given
>> >> how the Adobe doc says that some of those sub-topics are not phases.
>> >> Also, I think there is more than one way to develop an application.
>> >>
>> >> My temptation is to leave "Hello, World" as the end of the "Get
>>Started"
>> >> section.  Getting "Hello World" to work will prove that you have
>> >>properly
>> >> installed the SDK.  Then, I would like to suggest tweaking the
>>"Create
>> >>An
>> >> Application" section to be where we build an app in 10 minutes.  I
>>think
>> >> we should start with "Application Structure"  I will discuss the MVC
>> >> pattern there as an option.  Then the next section would be called
>> >> something like "A (10 Minute) Tutorial" and the sub-topics will be
>>major
>> >> steps towards building an example app.  It will take you through
>> >>building
>> >> the UI, network access, maybe data-binding, and it will address
>> >>building,
>> >> debugging, and deploying the example.  It will pick up enough of the
>> >> development phase information that I don't think we'll need a
>>separate
>> >> section for it.
>> >>
>> >> I'm shutting down for tonight so I'll see what your thoughts are
>>when I
>> >> get going again.  I could also draft my version in a branch if you
>>don't
>> >> want to mess with the develop branch right now.
>> >>
>> >> Thoughts?
>> >> -Alex
>> >>
>> >>
>> >--
>> >Andrew Wetmore
>> >
>> 
>>>https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fcottage1
>>>4
>> .
>> >blogspot.com%2F=02%7C01%7Caharui%40adobe.com%
>> 7Cfc7c34f4df27449408cf08
>> >d564aa6bd1%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%
>> 7C636525605481253150
>> >=gbSwjy2OMLy72u6Jna41ySDuPFO0K5tsjEV7ZZLnEo4%3D=0
>>
>>
>
>
>-- 
>Andrew Wetmore
>
>https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fcottage14.
>blogspot.com%2F=02%7C01%7Caharui%40adobe.com%7Ccd4e8ea7ad2844405a7908
>d564f50ec9%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636525926034660177
>=QZrNY2%2BwdrY%2FZ48rnKTpAN79N9g7q%2Bn%2BvmQPsHvrrSc%3D=0

Re: Links to sites outside of help docs

[Alex Harui]

On 1/26/18, 11:31 AM, "Andrew Wetmore"  wrote:

>Where do you suggest I put screenshots I want to share?

Most folks post the screenshot externally and put a link to it in the
email.  You can try posting the screenshot at paste.apache.org, pastebin,
dropbox, etc.  


>What I was
>concerned with is that, in the .md view I see
>
>... If you are looking for the API Reference, click
>here{:target='_blank'}.

Ah, ok. I had not looked there.  When I was searching for the answer, I
discovered that not all Markdown converters support the {:target='blank'}
option, but Jekyll does.  I just tested on the master branch where GitHub
Pages runs and it works there too, but it looks like whatever convert
GitHub uses on their site doesn't support it.
>
>I was not expecting to see the target information and, at that point, had
>not seen how the docs compile into HTML.
>
>So it looks like EITHER the method you suggested or the HTML method should
>work for links that pop a new tab.

I don't care which method we use.  Theoretically, we'll make fewer
mistakes with Markdown.  If you want to require everyone to use the same
technique, just pick one.  Note that the Markdown technique is actually
generalized in the Jekyll we and GitHub pages are using.  That syntax
really means that you can set any attribute on the converted HTML tag.  So
apparently, you could do "{:style='background-color:red'} or even
{:class='someclass'} and load some CSS that affects that tag.  But yes, it
will look funny in the GH view.  Not sure if GH knows about it and plans
to fix it.

Thanks,
-Alex
>
>On Fri, Jan 26, 2018 at 1:16 PM, Alex Harui 
>wrote:
>
>> Hi Andrew,
>>
>> Attachments often get stripped by Apache mailing lists.  Try using
>> paste.apache.org or pastebin and post a link.  I'm confused by your
>> email.  Links in a .md file won't pop a new window, but the result in
>>the
>> .html file after Jekyll processes it should have the right target.  I
>>just
>> tried it on the CI server and it worked in Safari and I don't see the
>>word
>> target in the text.
>>
>> 
>>https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fapacheroy
>>aleci.westus2.cloudapp.azure.com%3A8080%2Fjob%2F=02%7C01%7Caharui%40
>>adobe.com%7C5ee9085a985b4298437708d564f370f0%7Cfa7b1b5a7b34438794aed2c178
>>decee1%7C0%7C0%7C636525919093228589=xeujIhWdWU3WArJY2Hjap6Y1B15rR2v
>>4EZl7t5KR5DY%3D=0
>> RoyaleDocs_Staging/lastSuccessfulBuild/artifact/_site/index.html
>>
>> Let me know if you are seeing something different.
>>
>> -Alex
>>
>> From: Andrew Wetmore >
>> Reply-To: "dev@royale.apache.org" <
>> dev@royale.apache.org>
>> Date: Friday, January 26, 2018 at 4:43 AM
>> To: "dev@royale.apache.org" <
>> dev@royale.apache.org>
>> Subject: Links to sites outside of help docs
>>
>> Hi:
>>
>> Peeling this into its own thread.
>>
>> I looked at 
>>index.md>Fna01.safelinks.protection.outlook=02%7C01%7Caharui%40adobe.com%7C5e
>>e9085a985b4298437708d564f370f0%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0
>>%7C636525919093228589=p7Hfsb9opz6coJ27N8mikxfsja7Wffn7gE5k0tlGFZw%3
>>D=0.
>> com/?url=http%3A%2F%2Findex.md=02%7C01%7Caharui%40adobe.com%
>> 7Cfb5aa0f028424680cc3c08d564ba60a2%7Cfa7b1b5a7b34438794aed2c178de
>> cee1%7C0%7C0%7C636525674012827775=gY%2Ff4lQJBqOUHE9oDBjTI9Q%2B%
>> 2FHcsk5kKtEblwbpTWZ0%3D=0> and the syntax for popping a new tab
>> does not seem to work. See attached image, where the "target"
>>instructions
>> appear in the visible text.
>>
>> This discussion [1] proffers several solutions, including using just
>>plain
>> HTML. I have tried that on
>>create-an-application/migrate-an-existing-app/
>> 
>>migrate-from-flex.md>ttps%3A%2F%2Fna01.safelinks.protection.outlook=02%7C01%7Caharui%40ad
>>obe.com%7C5ee9085a985b4298437708d564f370f0%7Cfa7b1b5a7b34438794aed2c178de
>>cee1%7C0%7C0%7C636525919093228589=p7Hfsb9opz6coJ27N8mikxfsja7Wffn7g
>>E5k0tlGFZw%3D=0.
>> com/?url=http%3A%2F%2Fmigrate-from-flex.md=02%7C01%
>> 7Caharui%40adobe.com%7Cfb5aa0f028424680cc3c08d564ba60a2%
>> 7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636525674012827775=
>> o7OO7P%2Fwv7y9Wq8ZbAs8Eb7B8xX1waKjJPgRV6%2BMdjI%3D=0>. I don't
>> know where to look to verify that that works; could you check it?
>>
>> a
>>
>> [1] 
>>https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fstackove
>>rflow.com%2Fquestions%2F4425198%2Fcan-i-=02%7C01%7Caharui%40adobe.co
>>m%7C5ee9085a985b4298437708d564f370f0%7Cfa7b1b5a7b34438794aed2c178decee1%7
>>C0%7C0%7C636525919093228589=6PKVyGOIaD0%2BLwFgC%2F1puQtDc%2B%2Fllg8
>>%2BSthsyvdALKo%3D=0
>> create-links-with-target-blank-in-markdown> na01.safelinks.protection.outlook.com/?url=https%3A%2F%
>> 

Re: Royale Documentation Page Layout Proposal

[Piotr Zarzycki]

Cool!! :)

2018-01-26 21:18 GMT+01:00 Carlos Rovira :

> Hi,
>
> I'm playing with this concept
>
> https://royale.codeoscopic.com/documentation-page-example/
>
> Here I use:
>
> * The website page header
> * Royale logo white use
> * There's an alternate menu to configure (main website, blog, GitHub,...)
> * Search for docs (important)
>
> In content:
>
> * Main page doc title
> * Main doc section content (demo content to show something)
>
> Navigation:
>
> * Menu colapasable (accordion type)
> * Only 2 level
> * Menu content has some of the items I saw here and there, but is completly
> demo
>
>
> let me know what do you think
>
> Thanks
>
> --
> Carlos Rovira
> http://about.me/carlosrovira
>



-- 

Piotr Zarzycki

Patreon: *https://www.patreon.com/piotrzarzycki
*

Royale Documentation Page Layout Proposal

[Carlos Rovira]

Hi,

I'm playing with this concept

https://royale.codeoscopic.com/documentation-page-example/

Here I use:

* The website page header
* Royale logo white use
* There's an alternate menu to configure (main website, blog, GitHub,...)
* Search for docs (important)

In content:

* Main page doc title
* Main doc section content (demo content to show something)

Navigation:

* Menu colapasable (accordion type)
* Only 2 level
* Menu content has some of the items I saw here and there, but is completly
demo


let me know what do you think

Thanks

-- 
Carlos Rovira
http://about.me/carlosrovira

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

[Andrew Wetmore]

I don't think we need to build out the full ToC up front, rather than PAYG
haha. There are tons of pages that I have not yet listed in the Google doc,
and several decisions we have to make.

For example, we have an Express set of controls and MDL and who knows what
else. I presume we need to explain how these various sets of controls
relate to each other...

On Fri, Jan 26, 2018 at 1:09 PM, Alex Harui 
wrote:

> Hi Andrew,
>
> Responses in-line.
>
> On 1/26/18, 2:48 AM, "Andrew Wetmore"  wrote:
>
> >Good morning.
> >
> >Least thing first: Does the Apache header absolutely need to be in short
> >lines with hard line breaks so it takes up so much vertical space in the
> >file? Please look at test-apache-header.md and see whether the header
> laid
> >out on fewer lines and trusting to line wrapping works.
>
> I don't know for sure.  There is a header scanning tool that we use and I
> just tried it and it didn't mind your reformatting, so that's good enough
> for me.
> >
> >I am fine with your suggestions about where "Hello, World" should be and
> >how "Developing an application" might play out. However, this does raise
> >the question of whether this sort of help-docs structure is going to have
> >an index or other means to locate concepts like "data binding" if it is
> >tucked down in a larger set of instructions about applications rather than
> >being a entry itself.
>
> IMO, the 10-minute tutorial won't go into any serious detail about data
> binding, so "data binding" would have its own section wherever it makes
> sense and a link to it from the tutorial.
> >
> >I think the doc structure is still highly fluid and that we need to either
> >hold off on the ToC until we are closer to alpha-release of the
> >documentation, or have a less-bulky ToC document. My rough estimate is
> >that
> >we have stubs for less than 10% of the pages we will eventually have.
>
> IMO, the toc.json is relatively compact and much easier to change.  I'm
> not sure how to make it any smaller.  I could probably sit down and crank
> out all of the missing stubs in an evening, but is it worth it?  I like
> the fact that entries don't show up until we create a page for them.
>
> My 2 cents,
> -Alex
> >
> >On Fri, Jan 26, 2018 at 4:40 AM, Alex Harui 
> >wrote:
> >
> >> Hi Andrew,
> >>
> >> I took a quick peek at the Adobe doc.  I'm not sure "Development Phases"
> >> should be the first thing under "Create an application", especially
> >>given
> >> how the Adobe doc says that some of those sub-topics are not phases.
> >> Also, I think there is more than one way to develop an application.
> >>
> >> My temptation is to leave "Hello, World" as the end of the "Get Started"
> >> section.  Getting "Hello World" to work will prove that you have
> >>properly
> >> installed the SDK.  Then, I would like to suggest tweaking the "Create
> >>An
> >> Application" section to be where we build an app in 10 minutes.  I think
> >> we should start with "Application Structure"  I will discuss the MVC
> >> pattern there as an option.  Then the next section would be called
> >> something like "A (10 Minute) Tutorial" and the sub-topics will be major
> >> steps towards building an example app.  It will take you through
> >>building
> >> the UI, network access, maybe data-binding, and it will address
> >>building,
> >> debugging, and deploying the example.  It will pick up enough of the
> >> development phase information that I don't think we'll need a separate
> >> section for it.
> >>
> >> I'm shutting down for tonight so I'll see what your thoughts are when I
> >> get going again.  I could also draft my version in a branch if you don't
> >> want to mess with the develop branch right now.
> >>
> >> Thoughts?
> >> -Alex
> >>
> >>
> >--
> >Andrew Wetmore
> >
> >https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fcottage14
> .
> >blogspot.com%2F=02%7C01%7Caharui%40adobe.com%
> 7Cfc7c34f4df27449408cf08
> >d564aa6bd1%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%
> 7C636525605481253150
> >=gbSwjy2OMLy72u6Jna41ySDuPFO0K5tsjEV7ZZLnEo4%3D=0
>
>


-- 
Andrew Wetmore

http://cottage14.blogspot.com/

Re: ***UNCHECKED*** Re: Help docs ToC and links

[Andrew Wetmore]

I would like to hold off on merging for a few more days, until we have
worked out the kinks we know of and have a few pages that have significant
information.

a

On Fri, Jan 26, 2018 at 1:20 PM, Alex Harui 
wrote:

> The develop branch is built by our CI server.  The results are here:
>
> http://apacheroyaleci.westus2.cloudapp.azure.com:8080/job/
> RoyaleDocs_Stagin
> g/lastSuccessfulBuild/artifact/_site/index.html
>
> Theoretically, when we merge develop into master, GH pages will process it
> and it will show up here:
>
> https://apache.github.io/royale-docs/
>
> We can try a merge now if you want.  Would need Andrew's ok before doing
> so.  Not sure if our partial work in develop is better than the
> placeholder in master.
>
> Thoughts?
> -Alex
>
> On 1/26/18, 3:27 AM, "Gabe Harbs"  wrote:
>
> >I’m trying to find my bearings after following lightly for a couple of
> >weeks.
> >
> >I’m really excited by all the work that’s been going on vis a vis docs
> >lately. I think it’s really important work and really glad it’s happening.
> >
> >How do I view the current status of the work on docs? I see there’s a
> >develop branch on the docs repo, but I’m not sure how to actually view
> >that. Is there a URL that Jekyll outputs changes to? Is it built locally,
> >and if yes how? How is changes actually published by Jekyll to the docs
> >GitHub.io site?
> >
> >Thanks,
> >Harbs
> >
> >> On Jan 26, 2018, at 9:14 AM, Alex Harui 
> >>wrote:
> >>
> >> OK, I figured out how to generate the ToC from a JSON file
> >> (_data/toc.json).  Basically, it is a hierarchical structure.  Each ToC
> >> entry is a JSON Object with a path property and an optional children
> >>array
> >> of other ToC entries.
> >>
> >> The title and links are pulled from the site information gathered by
> >> Jekyll, so you won't see ToC entries on the page for entries in the
> >> toc.json that don't have an actual file.  Which also means that if you
> >> don't match the path to the actual file name it won't show either.  Make
> >> sure you have your capital letters and everything correct.
> >>
> >> I also figured you were asleep at this hour so I did the license sweep.
> >> Make sure you sync up any local working copies before making more
> >>changes.
> >>
> >> On 1/25/18, 6:51 PM, "Alex Harui"  wrote:
> >>
> >>> OK, I saw your other email about more ToC changes coming.  I think I am
> >>> going to try to generate the ToC.
> >>>
> >>> -Alex
> >>>
> >>> On 1/25/18, 6:32 PM, "Alex Harui"  wrote:
> >>>
>  On 1/25/18, 4:11 PM, "Andrew Wetmore"  wrote:
> 
> > Hi:
> >
> > I have not been touching the ToC file because it looks very easy to
> >get
> > wrong.
> 
>  Yeah, I was fiddling with the ToC and thinking the same thing.  I'm
>  wondering how many more changes to the ToC we'll be doing.  If it is
> just
>  a few more to implement your proposed ToC, we could just keep the
> current
>  way and fix the small things as we find it.  If we think we're going
> to
>  be
>  adding new entries and/or renaming entries, maybe it is worth it for
> me
>  to
>  try to spend a day making the ToC "generate" from the .MD files.  We
>  would
>  probably dictate the organization of the ToC in a JSON file, but the
>  entries would be less error prone.  Maybe like:
> 
>  { "toc": [ "index.md" : [ "welcome/high-level-view.md" : [] ,
>  "welcome/features-and-concepts.md": [
>  "welcome/features/as3.md" ...
>   "get-started.md" : ["get-started/system-requirements.md" ...
> 
>  Essentially, a hierarchical object that just lists the file names in
> the
>  order you want them to appear in the ToC.  I think I can get Jekyll to
>  generate the ToC by using the page titles.
> 
> 
> 
> > I have also not been inserting links from one .md page to another
> > because I am not clear whether we are using relative or absolute
> >links
> > (not
> > sure, for instance, whether there is a performance benefit of one
> >over
> > the
> > other...).
> 
>  In the .md files, links have to be a full path without the leading
> slash.
>  So to link to /welcome/features/as3.md, you would use
> 
>  [as3](welcome/features/as3.html)
> 
> >
> > Also, when we link out from the help docs to another section of the
> > Royale
> > site, or any other resource, we should pop a new browser window, not
> > take
> > the reader away from the help docs. Is there a standard way to
> >declare
> > that
> > when writing a link in markdown? Is it the same as in HTML
> > ("target=_blank")?
> 
>  I had to look it up.  The syntax is:
> 
> > [as3](welcome/features/as3.html){:target='_blank'}
> 

help text and background image

[Andrew Wetmore]

Hi:

If you look at a help doc page that has a bunch of text, like "Migrate from
Flex" [1], the background image renders the text on the right of the screen
almost unreadable.

[1]
http://apacheroyaleci.westus2.cloudapp.azure.com:8080/job/RoyaleDocs_Staging/lastSuccessfulBuild/artifact/_site/create-an-application/migrate-an-existing-app/migrate-from-flex.html


==
Andrew Wetmore

http://cottage14.blogspot.com/

Re: Links to sites outside of help docs

[Andrew Wetmore]

Where do you suggest I put screenshots I want to share? What I was
concerned with is that, in the .md view I see

... If you are looking for the API Reference, click here

{:target='_blank'}.

I was not expecting to see the target information and, at that point, had
not seen how the docs compile into HTML.

So it looks like EITHER the method you suggested or the HTML method should
work for links that pop a new tab.

On Fri, Jan 26, 2018 at 1:16 PM, Alex Harui 
wrote:

> Hi Andrew,
>
> Attachments often get stripped by Apache mailing lists.  Try using
> paste.apache.org or pastebin and post a link.  I'm confused by your
> email.  Links in a .md file won't pop a new window, but the result in the
> .html file after Jekyll processes it should have the right target.  I just
> tried it on the CI server and it worked in Safari and I don't see the word
> target in the text.
>
> http://apacheroyaleci.westus2.cloudapp.azure.com:8080/job/
> RoyaleDocs_Staging/lastSuccessfulBuild/artifact/_site/index.html
>
> Let me know if you are seeing something different.
>
> -Alex
>
> From: Andrew Wetmore >
> Reply-To: "dev@royale.apache.org" <
> dev@royale.apache.org>
> Date: Friday, January 26, 2018 at 4:43 AM
> To: "dev@royale.apache.org" <
> dev@royale.apache.org>
> Subject: Links to sites outside of help docs
>
> Hi:
>
> Peeling this into its own thread.
>
> I looked at index.md com/?url=http%3A%2F%2Findex.md=02%7C01%7Caharui%40adobe.com%
> 7Cfb5aa0f028424680cc3c08d564ba60a2%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0%7C0%7C636525674012827775=gY%2Ff4lQJBqOUHE9oDBjTI9Q%2B%
> 2FHcsk5kKtEblwbpTWZ0%3D=0> and the syntax for popping a new tab
> does not seem to work. See attached image, where the "target" instructions
> appear in the visible text.
>
> This discussion [1] proffers several solutions, including using just plain
> HTML. I have tried that on create-an-application/migrate-an-existing-app/
> migrate-from-flex.md com/?url=http%3A%2F%2Fmigrate-from-flex.md=02%7C01%
> 7Caharui%40adobe.com%7Cfb5aa0f028424680cc3c08d564ba60a2%
> 7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636525674012827775=
> o7OO7P%2Fwv7y9Wq8ZbAs8Eb7B8xX1waKjJPgRV6%2BMdjI%3D=0>. I don't
> know where to look to verify that that works; could you check it?
>
> a
>
> [1] https://stackoverflow.com/questions/4425198/can-i-
> create-links-with-target-blank-in-markdown na01.safelinks.protection.outlook.com/?url=https%3A%2F%
> 2Fstackoverflow.com%2Fquestions%2F4425198%2Fcan-i-
> create-links-with-target-blank-in-markdown=02%
> 7C01%7Caharui%40adobe.com%7Cfb5aa0f028424680cc3c08d564ba60a2%
> 7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636525674012827775=
> mmZxwnyxhHJfytKQy%2BIrJ%2FSM%2B8%2BewTG%2FaGonKB9fIC4%3D=0>
>
> --
> Andrew Wetmore
>
> http://cottage14.blogspot.com/ protection.outlook.com/?url=http%3A%2F%2Fcottage14.
> blogspot.com%2F=02%7C01%7Caharui%40adobe.com%
> 7Cfb5aa0f028424680cc3c08d564ba60a2%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0%7C0%7C636525674012827775=hqTw9WWdtUpLzMTqGph83lb2nQyyxZ
> 8d40Rx3b3qE64%3D=0>
>
>
>
>
>


-- 
Andrew Wetmore

http://cottage14.blogspot.com/

Re: Images and other assets?

[Andrew Wetmore]

Okay, so I should upload the first image I am playing with to a new
"assets" folder in the help docs structure.

I'll try that.

On Fri, Jan 26, 2018 at 2:11 PM, Carlos Rovira 
wrote:

> I think we should host the royale docs images and assets in the same
> roayle-docs repo.
> For example, if we want to use a royale logo for royale docs, I'll be
> preparing the logo use for this concrete set of pages, and hosted with
> them.
> Maybe the header could have a concrete image designed only for docs, hence
> that image will be in its repo and not taken from the website.
> If some assets coincide with other in website that's normal, but its uses
> could be different (in fact are different since one is used in web and
> other in docs)
>
> 2018-01-26 17:37 GMT+01:00 Alex Harui :
>
> > Links from royale-docs to the royale website on royale.a.o would require
> > absolute links.  Right now the template is still picking up an asset for
> > Carlos's site and probably should change to pick it up from royale.a.o.
> >
> > I don't think we've done any links to images specific to royale-docs.
> > Jekyll says to do this [1] but because we are using  tags I think
> > you have to drop the leading slash.
> >
> > HTH,
> > -Alex
> >
> > [1] https://jekyllrb.com/docs/posts/
> >
> > On 1/26/18, 6:18 AM, "Gabe Harbs"  wrote:
> >
> > >I think relative links would work. (Although I could be missing
> something)
> > >
> > >Harbs
> > >
> > >> On Jan 26, 2018, at 4:04 PM, Andrew Wetmore 
> > wrote:
> > >>
> > >> No. All I would need to know is where the website repo is, and how to
> > >>link
> > >> from the docs to an image stored there.
> > >>
> > >> On Fri, Jan 26, 2018 at 9:55 AM, Gabe Harbs 
> > >>wrote:
> > >>
> > >>> I would assume that images for the website would go in the website
> repo
> > >>> and doc images would go in the docs repo.
> > >>>
> > >>> Any reason why that would be problematic?
> > >>>
> > >>> Harbs
> > >>>
> >  On Jan 26, 2018, at 3:50 PM, Andrew Wetmore 
> > wrote:
> > 
> >  Where are we hosting images and other assets for the website in
> > general
> > >>> and
> >  the user documentation in particular?
> > 
> >  --
> >  Andrew Wetmore
> > 
> > 
> > https://na01.safelinks.protection.outlook.com/?url=
> > http%3A%2F%2Fcottage
> > 14.blogspot.com%2F=02%7C01%7Caharui%40adobe.com%
> > 7C27b04fd07bc54589
> > 4c3008d564c7bce4%7Cfa7b1b5a7b34438794aed2c178de
> > cee1%7C0%7C0%7C636525731
> > 388973298=Y7ywcVKZa4bZY2RuEGExtUHVfw%
> > 2B8Hu6hXTnq%2FYPpQlI%3D
> > rved=0
> > >>>
> > >>>
> > >>
> > >>
> > >> --
> > >> Andrew Wetmore
> > >>
> > >>
> > >>https://na01.safelinks.protection.outlook.com/?url=
> > http%3A%2F%2Fcottage14
> > >>.blogspot.com%2F=02%7C01%7Caharui%40adobe.com%
> > 7C27b04fd07bc545894c30
> > >>08d564c7bce4%7Cfa7b1b5a7b34438794aed2c178de
> > cee1%7C0%7C0%7C636525731388973
> > >>298=Y7ywcVKZa4bZY2RuEGExtUHVfw%2B8Hu6hXTnq%2FYPpQlI%3D&
> reserved=0
> > >
> >
> >
>
>
> --
> Carlos Rovira
> http://about.me/carlosrovira
>



-- 
Andrew Wetmore

http://cottage14.blogspot.com/

Re: Images and other assets?

[Carlos Rovira]

I think we should host the royale docs images and assets in the same
roayle-docs repo.
For example, if we want to use a royale logo for royale docs, I'll be
preparing the logo use for this concrete set of pages, and hosted with them.
Maybe the header could have a concrete image designed only for docs, hence
that image will be in its repo and not taken from the website.
If some assets coincide with other in website that's normal, but its uses
could be different (in fact are different since one is used in web and
other in docs)

2018-01-26 17:37 GMT+01:00 Alex Harui :

> Links from royale-docs to the royale website on royale.a.o would require
> absolute links.  Right now the template is still picking up an asset for
> Carlos's site and probably should change to pick it up from royale.a.o.
>
> I don't think we've done any links to images specific to royale-docs.
> Jekyll says to do this [1] but because we are using  tags I think
> you have to drop the leading slash.
>
> HTH,
> -Alex
>
> [1] https://jekyllrb.com/docs/posts/
>
> On 1/26/18, 6:18 AM, "Gabe Harbs"  wrote:
>
> >I think relative links would work. (Although I could be missing something)
> >
> >Harbs
> >
> >> On Jan 26, 2018, at 4:04 PM, Andrew Wetmore 
> wrote:
> >>
> >> No. All I would need to know is where the website repo is, and how to
> >>link
> >> from the docs to an image stored there.
> >>
> >> On Fri, Jan 26, 2018 at 9:55 AM, Gabe Harbs 
> >>wrote:
> >>
> >>> I would assume that images for the website would go in the website repo
> >>> and doc images would go in the docs repo.
> >>>
> >>> Any reason why that would be problematic?
> >>>
> >>> Harbs
> >>>
>  On Jan 26, 2018, at 3:50 PM, Andrew Wetmore 
> wrote:
> 
>  Where are we hosting images and other assets for the website in
> general
> >>> and
>  the user documentation in particular?
> 
>  --
>  Andrew Wetmore
> 
> 
> https://na01.safelinks.protection.outlook.com/?url=
> http%3A%2F%2Fcottage
> 14.blogspot.com%2F=02%7C01%7Caharui%40adobe.com%
> 7C27b04fd07bc54589
> 4c3008d564c7bce4%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0%7C0%7C636525731
> 388973298=Y7ywcVKZa4bZY2RuEGExtUHVfw%
> 2B8Hu6hXTnq%2FYPpQlI%3D
> rved=0
> >>>
> >>>
> >>
> >>
> >> --
> >> Andrew Wetmore
> >>
> >>
> >>https://na01.safelinks.protection.outlook.com/?url=
> http%3A%2F%2Fcottage14
> >>.blogspot.com%2F=02%7C01%7Caharui%40adobe.com%
> 7C27b04fd07bc545894c30
> >>08d564c7bce4%7Cfa7b1b5a7b34438794aed2c178de
> cee1%7C0%7C0%7C636525731388973
> >>298=Y7ywcVKZa4bZY2RuEGExtUHVfw%2B8Hu6hXTnq%2FYPpQlI%3D=0
> >
>
>


-- 
Carlos Rovira
http://about.me/carlosrovira

Re: Proposed table of contents for Royale help documentation

[Carlos Rovira]

I'll try that route and see what I get. I'll be back with my results.

2018-01-26 3:15 GMT+01:00 Alex Harui :

> Hi Carlos,
>
> I don't know how big the changes you are thinking of and how much time you
> have, but you could mock up something in your WP instance or post an image
> and I could try to make the changes in the current template.
>
> Let me know,
> -Alex
>
> On 1/25/18, 4:17 PM, "carlos.rov...@gmail.com on behalf of Carlos Rovira"
>  wrote:
>
> >Hi Alex,
> >
> >getting up with the last day info. Right, I'll try this week-end to make
> >something that looks good. First I have to figure how to work taking into
> >account the other threads I read and the way you guys are working.
> >Thanks
> >
> >2018-01-25 0:23 GMT+01:00 Alex Harui :
> >
> >> MIT is fine, as is BSD.  But again, if the theme has many parts, it may
> >> result in the PMC spending time researching each of the parts.  Just
> >> because the theme author claims MIT for his work, he might have used
> >> third-party works under other licenses that aren't as compatible with
> >>the
> >> Apache License.
> >>
> >> I guess my question is this:  I don't expect that the look-and-feel of
> >>our
> >> documentation pages needs much if any animation.  IOW, I would think the
> >> visuals around the content will be pretty much static.  If that's the
> >> case, why will it be so difficult to just continue improving the
> >>template
> >> I put in there?  If you want to take a theme and WP and mock up
> >>something
> >> quickly, that's fine as long as all of the creativity can be considered
> >> yours or under a friendly license.  But maybe instead of another export
> >>of
> >> a WP theme, we should just try to mimic that in plain HTML.  I think I
> >>got
> >> pretty close to the royale.a.o look in the docpage.html template.
> >>
> >> Thoughts?
> >> -Alex
> >>
> >> On 1/24/18, 1:57 PM, "carlos.rov...@gmail.com on behalf of Carlos
> >>Rovira"
> >>  wrote:
> >>
> >> >Hi Alex,
> >> >
> >> >right, I'm looking for something that is ALv2. Unfortunately almost all
> >> >docs themes are MIT license. Is MIT right for us?
> >> >
> >> >2018-01-24 18:14 GMT+01:00 Alex Harui :
> >> >
> >> >> Hi Carlos,
> >> >>
> >> >> Right now, the master branch is set up to use the Cayman theme.
> >>When I
> >> >> took a quick look at Cayman, it appeared to be under Creative
> >>Commons,
> >> >> which makes it very difficult for us to use.  Unfortunately, just
> >> >>because
> >> >> it is "Open Source" and on GitHub doesn't mean it is compatible with
> >>the
> >> >> Apache License.  That was one reason I put in a docpage.html as the
> >> >> initial template for the doc site.  If you can find a simple theme
> >>that
> >> >> isn't under CC, then let's take a look at it, but every third party
> >> >>theme
> >> >> seems to have lots of pieces and is going to have to get scrubbed
> >>which
> >> >> takes us time thinking about legal stuff.  I believe we can
> >> >>incrementally
> >> >> add to the initial template or make different templates over time and
> >> >>make
> >> >> a first-class doc site without having to spend so much time scrubbing
> >> >> other people's works.  I don't think people are going to care too
> >>much
> >> >> about how cool our doc site is, at least not right now.  I don't
> >>think
> >> >> there is a rush to make it cool.  On the other hand, we do want to
> >>make
> >> >>a
> >> >> good first impression over at royale.a.o, which is why I'm glad you
> >>have
> >> >> provided something great for that.
> >> >>
> >> >> My 2 cents,
> >> >> -Alex
> >> >>
> >> >> On 1/24/18, 12:45 AM, "carlos.rov...@gmail.com on behalf of Carlos
> >> >>Rovira"
> >> >> 
> wrote:
> >> >>
> >> >> >Hi Alex, for this reason is better to go with a OS GitHub theme that
> >> >>only
> >> >> >needs to use the colors, fonts and logos from our website. Those
> >>where
> >> >> >selected by me and are not provided by the WP theme. The other main
> >> >>reason
> >> >> >is that we need to use something done for that task with the maximum
> >> >> >quality. And that is something we can develop ourselves from scratch
> >> >> >without invest lots of time.
> >> >> >
> >> >> >2018-01-24 5:10 GMT+01:00 Alex Harui :
> >> >> >
> >> >> >> Personally, I would be very cautious about WP themes or copying
> >> >> >> look-and-feel of other sites.  I would like our doc to be
> >> >>license-able
> >> >> >> under ALv2 and not run into IP and licensing issues.
> >> >> >>
> >> >> >> -Alex
> >> >> >>
> >> >> >> On 1/23/18, 3:11 PM, "carlos.rov...@gmail.com on behalf of Carlos
> >> >> >>Rovira"
> >> >> >> 
> >> wrote:
> >> >> >>
> >> >> >> >Hi,
> >> >> >> >
> >> >> >> >I tried 

Re: ***UNCHECKED*** Re: Help docs ToC and links

[Carlos Rovira]

Hi Alex,

I think we should wait for something more suited for production. At least
work on the presentation and have a minimum content.

2018-01-26 18:20 GMT+01:00 Alex Harui :

> The develop branch is built by our CI server.  The results are here:
>
> http://apacheroyaleci.westus2.cloudapp.azure.com:8080/job/
> RoyaleDocs_Stagin
> g/lastSuccessfulBuild/artifact/_site/index.html
>
> Theoretically, when we merge develop into master, GH pages will process it
> and it will show up here:
>
> https://apache.github.io/royale-docs/
>
> We can try a merge now if you want.  Would need Andrew's ok before doing
> so.  Not sure if our partial work in develop is better than the
> placeholder in master.
>
> Thoughts?
> -Alex
>
> On 1/26/18, 3:27 AM, "Gabe Harbs"  wrote:
>
> >I’m trying to find my bearings after following lightly for a couple of
> >weeks.
> >
> >I’m really excited by all the work that’s been going on vis a vis docs
> >lately. I think it’s really important work and really glad it’s happening.
> >
> >How do I view the current status of the work on docs? I see there’s a
> >develop branch on the docs repo, but I’m not sure how to actually view
> >that. Is there a URL that Jekyll outputs changes to? Is it built locally,
> >and if yes how? How is changes actually published by Jekyll to the docs
> >GitHub.io site?
> >
> >Thanks,
> >Harbs
> >
> >> On Jan 26, 2018, at 9:14 AM, Alex Harui 
> >>wrote:
> >>
> >> OK, I figured out how to generate the ToC from a JSON file
> >> (_data/toc.json).  Basically, it is a hierarchical structure.  Each ToC
> >> entry is a JSON Object with a path property and an optional children
> >>array
> >> of other ToC entries.
> >>
> >> The title and links are pulled from the site information gathered by
> >> Jekyll, so you won't see ToC entries on the page for entries in the
> >> toc.json that don't have an actual file.  Which also means that if you
> >> don't match the path to the actual file name it won't show either.  Make
> >> sure you have your capital letters and everything correct.
> >>
> >> I also figured you were asleep at this hour so I did the license sweep.
> >> Make sure you sync up any local working copies before making more
> >>changes.
> >>
> >> On 1/25/18, 6:51 PM, "Alex Harui"  wrote:
> >>
> >>> OK, I saw your other email about more ToC changes coming.  I think I am
> >>> going to try to generate the ToC.
> >>>
> >>> -Alex
> >>>
> >>> On 1/25/18, 6:32 PM, "Alex Harui"  wrote:
> >>>
>  On 1/25/18, 4:11 PM, "Andrew Wetmore"  wrote:
> 
> > Hi:
> >
> > I have not been touching the ToC file because it looks very easy to
> >get
> > wrong.
> 
>  Yeah, I was fiddling with the ToC and thinking the same thing.  I'm
>  wondering how many more changes to the ToC we'll be doing.  If it is
> just
>  a few more to implement your proposed ToC, we could just keep the
> current
>  way and fix the small things as we find it.  If we think we're going
> to
>  be
>  adding new entries and/or renaming entries, maybe it is worth it for
> me
>  to
>  try to spend a day making the ToC "generate" from the .MD files.  We
>  would
>  probably dictate the organization of the ToC in a JSON file, but the
>  entries would be less error prone.  Maybe like:
> 
>  { "toc": [ "index.md" : [ "welcome/high-level-view.md" : [] ,
>  "welcome/features-and-concepts.md": [
>  "welcome/features/as3.md" ...
>   "get-started.md" : ["get-started/system-requirements.md" ...
> 
>  Essentially, a hierarchical object that just lists the file names in
> the
>  order you want them to appear in the ToC.  I think I can get Jekyll to
>  generate the ToC by using the page titles.
> 
> 
> 
> > I have also not been inserting links from one .md page to another
> > because I am not clear whether we are using relative or absolute
> >links
> > (not
> > sure, for instance, whether there is a performance benefit of one
> >over
> > the
> > other...).
> 
>  In the .md files, links have to be a full path without the leading
> slash.
>  So to link to /welcome/features/as3.md, you would use
> 
>  [as3](welcome/features/as3.html)
> 
> >
> > Also, when we link out from the help docs to another section of the
> > Royale
> > site, or any other resource, we should pop a new browser window, not
> > take
> > the reader away from the help docs. Is there a standard way to
> >declare
> > that
> > when writing a link in markdown? Is it the same as in HTML
> > ("target=_blank")?
> 
>  I had to look it up.  The syntax is:
> 
> > [as3](welcome/features/as3.html){:target='_blank'}
> 
>  I just modified index.md 

***UNCHECKED*** Re: Help docs ToC and links

[Alex Harui]

The develop branch is built by our CI server.  The results are here:

http://apacheroyaleci.westus2.cloudapp.azure.com:8080/job/RoyaleDocs_Stagin
g/lastSuccessfulBuild/artifact/_site/index.html

Theoretically, when we merge develop into master, GH pages will process it
and it will show up here:

https://apache.github.io/royale-docs/

We can try a merge now if you want.  Would need Andrew's ok before doing
so.  Not sure if our partial work in develop is better than the
placeholder in master.

Thoughts?
-Alex

On 1/26/18, 3:27 AM, "Gabe Harbs"  wrote:

>I’m trying to find my bearings after following lightly for a couple of
>weeks.
>
>I’m really excited by all the work that’s been going on vis a vis docs
>lately. I think it’s really important work and really glad it’s happening.
>
>How do I view the current status of the work on docs? I see there’s a
>develop branch on the docs repo, but I’m not sure how to actually view
>that. Is there a URL that Jekyll outputs changes to? Is it built locally,
>and if yes how? How is changes actually published by Jekyll to the docs
>GitHub.io site?
>
>Thanks,
>Harbs
>
>> On Jan 26, 2018, at 9:14 AM, Alex Harui 
>>wrote:
>> 
>> OK, I figured out how to generate the ToC from a JSON file
>> (_data/toc.json).  Basically, it is a hierarchical structure.  Each ToC
>> entry is a JSON Object with a path property and an optional children
>>array
>> of other ToC entries.
>> 
>> The title and links are pulled from the site information gathered by
>> Jekyll, so you won't see ToC entries on the page for entries in the
>> toc.json that don't have an actual file.  Which also means that if you
>> don't match the path to the actual file name it won't show either.  Make
>> sure you have your capital letters and everything correct.
>> 
>> I also figured you were asleep at this hour so I did the license sweep.
>> Make sure you sync up any local working copies before making more
>>changes.
>> 
>> On 1/25/18, 6:51 PM, "Alex Harui"  wrote:
>> 
>>> OK, I saw your other email about more ToC changes coming.  I think I am
>>> going to try to generate the ToC.
>>> 
>>> -Alex
>>> 
>>> On 1/25/18, 6:32 PM, "Alex Harui"  wrote:
>>> 
 On 1/25/18, 4:11 PM, "Andrew Wetmore"  wrote:
 
> Hi:
> 
> I have not been touching the ToC file because it looks very easy to
>get
> wrong. 
 
 Yeah, I was fiddling with the ToC and thinking the same thing.  I'm
 wondering how many more changes to the ToC we'll be doing.  If it is
just
 a few more to implement your proposed ToC, we could just keep the
current
 way and fix the small things as we find it.  If we think we're going
to
 be
 adding new entries and/or renaming entries, maybe it is worth it for
me
 to
 try to spend a day making the ToC "generate" from the .MD files.  We
 would
 probably dictate the organization of the ToC in a JSON file, but the
 entries would be less error prone.  Maybe like:
 
 { "toc": [ "index.md" : [ "welcome/high-level-view.md" : [] ,
 "welcome/features-and-concepts.md": [
 "welcome/features/as3.md" ...
  "get-started.md" : ["get-started/system-requirements.md" ...
 
 Essentially, a hierarchical object that just lists the file names in
the
 order you want them to appear in the ToC.  I think I can get Jekyll to
 generate the ToC by using the page titles.
 
 
 
> I have also not been inserting links from one .md page to another
> because I am not clear whether we are using relative or absolute
>links
> (not
> sure, for instance, whether there is a performance benefit of one
>over
> the
> other...).
 
 In the .md files, links have to be a full path without the leading
slash.
 So to link to /welcome/features/as3.md, you would use
 
 [as3](welcome/features/as3.html)
 
> 
> Also, when we link out from the help docs to another section of the
> Royale
> site, or any other resource, we should pop a new browser window, not
> take
> the reader away from the help docs. Is there a standard way to
>declare
> that
> when writing a link in markdown? Is it the same as in HTML
> ("target=_blank")?
 
 I had to look it up.  The syntax is:
 
> [as3](welcome/features/as3.html){:target='_blank'}
 
 I just modified index.md and tested it and it seemed to work.
 
 -Alex
 
>>> 
>> 
>

Re: Links to sites outside of help docs

[Alex Harui]

Hi Andrew,

Attachments often get stripped by Apache mailing lists.  Try using 
paste.apache.org or pastebin and post a link.  I'm confused by your email.  
Links in a .md file won't pop a new window, but the result in the .html file 
after Jekyll processes it should have the right target.  I just tried it on the 
CI server and it worked in Safari and I don't see the word target in the text.

http://apacheroyaleci.westus2.cloudapp.azure.com:8080/job/RoyaleDocs_Staging/lastSuccessfulBuild/artifact/_site/index.html

Let me know if you are seeing something different.

-Alex

From: Andrew Wetmore >
Reply-To: "dev@royale.apache.org" 
>
Date: Friday, January 26, 2018 at 4:43 AM
To: "dev@royale.apache.org" 
>
Subject: Links to sites outside of help docs

Hi:

Peeling this into its own thread.

I looked at 
index.md
 and the syntax for popping a new tab does not seem to work. See attached 
image, where the "target" instructions appear in the visible text.

This discussion [1] proffers several solutions, including using just plain 
HTML. I have tried that on 
create-an-application/migrate-an-existing-app/migrate-from-flex.md.
 I don't know where to look to verify that that works; could you check it?

a

[1] 
https://stackoverflow.com/questions/4425198/can-i-create-links-with-target-blank-in-markdown

--
Andrew Wetmore

http://cottage14.blogspot.com/

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

[Alex Harui]

Hi Andrew,

Responses in-line.

On 1/26/18, 2:48 AM, "Andrew Wetmore"  wrote:

>Good morning.
>
>Least thing first: Does the Apache header absolutely need to be in short
>lines with hard line breaks so it takes up so much vertical space in the
>file? Please look at test-apache-header.md and see whether the header laid
>out on fewer lines and trusting to line wrapping works.

I don't know for sure.  There is a header scanning tool that we use and I
just tried it and it didn't mind your reformatting, so that's good enough
for me.
>
>I am fine with your suggestions about where "Hello, World" should be and
>how "Developing an application" might play out. However, this does raise
>the question of whether this sort of help-docs structure is going to have
>an index or other means to locate concepts like "data binding" if it is
>tucked down in a larger set of instructions about applications rather than
>being a entry itself.

IMO, the 10-minute tutorial won't go into any serious detail about data
binding, so "data binding" would have its own section wherever it makes
sense and a link to it from the tutorial.
>
>I think the doc structure is still highly fluid and that we need to either
>hold off on the ToC until we are closer to alpha-release of the
>documentation, or have a less-bulky ToC document. My rough estimate is
>that
>we have stubs for less than 10% of the pages we will eventually have.

IMO, the toc.json is relatively compact and much easier to change.  I'm
not sure how to make it any smaller.  I could probably sit down and crank
out all of the missing stubs in an evening, but is it worth it?  I like
the fact that entries don't show up until we create a page for them.

My 2 cents,
-Alex
>
>On Fri, Jan 26, 2018 at 4:40 AM, Alex Harui 
>wrote:
>
>> Hi Andrew,
>>
>> I took a quick peek at the Adobe doc.  I'm not sure "Development Phases"
>> should be the first thing under "Create an application", especially
>>given
>> how the Adobe doc says that some of those sub-topics are not phases.
>> Also, I think there is more than one way to develop an application.
>>
>> My temptation is to leave "Hello, World" as the end of the "Get Started"
>> section.  Getting "Hello World" to work will prove that you have
>>properly
>> installed the SDK.  Then, I would like to suggest tweaking the "Create
>>An
>> Application" section to be where we build an app in 10 minutes.  I think
>> we should start with "Application Structure"  I will discuss the MVC
>> pattern there as an option.  Then the next section would be called
>> something like "A (10 Minute) Tutorial" and the sub-topics will be major
>> steps towards building an example app.  It will take you through
>>building
>> the UI, network access, maybe data-binding, and it will address
>>building,
>> debugging, and deploying the example.  It will pick up enough of the
>> development phase information that I don't think we'll need a separate
>> section for it.
>>
>> I'm shutting down for tonight so I'll see what your thoughts are when I
>> get going again.  I could also draft my version in a branch if you don't
>> want to mess with the develop branch right now.
>>
>> Thoughts?
>> -Alex
>>
>>
>-- 
>Andrew Wetmore
>
>https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fcottage14.
>blogspot.com%2F=02%7C01%7Caharui%40adobe.com%7Cfc7c34f4df27449408cf08
>d564aa6bd1%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636525605481253150
>=gbSwjy2OMLy72u6Jna41ySDuPFO0K5tsjEV7ZZLnEo4%3D=0

Re: Images and other assets?

[Alex Harui]

Links from royale-docs to the royale website on royale.a.o would require
absolute links.  Right now the template is still picking up an asset for
Carlos's site and probably should change to pick it up from royale.a.o.

I don't think we've done any links to images specific to royale-docs.
Jekyll says to do this [1] but because we are using  tags I think
you have to drop the leading slash.

HTH,
-Alex

[1] https://jekyllrb.com/docs/posts/

On 1/26/18, 6:18 AM, "Gabe Harbs"  wrote:

>I think relative links would work. (Although I could be missing something)
>
>Harbs
>
>> On Jan 26, 2018, at 4:04 PM, Andrew Wetmore  wrote:
>> 
>> No. All I would need to know is where the website repo is, and how to
>>link
>> from the docs to an image stored there.
>> 
>> On Fri, Jan 26, 2018 at 9:55 AM, Gabe Harbs 
>>wrote:
>> 
>>> I would assume that images for the website would go in the website repo
>>> and doc images would go in the docs repo.
>>> 
>>> Any reason why that would be problematic?
>>> 
>>> Harbs
>>> 
 On Jan 26, 2018, at 3:50 PM, Andrew Wetmore 
wrote:
 
 Where are we hosting images and other assets for the website in
general
>>> and
 the user documentation in particular?
 
 --
 Andrew Wetmore
 
 
https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fcottage
14.blogspot.com%2F=02%7C01%7Caharui%40adobe.com%7C27b04fd07bc54589
4c3008d564c7bce4%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636525731
388973298=Y7ywcVKZa4bZY2RuEGExtUHVfw%2B8Hu6hXTnq%2FYPpQlI%3D
rved=0
>>> 
>>> 
>> 
>> 
>> -- 
>> Andrew Wetmore
>> 
>> 
>>https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fcottage14
>>.blogspot.com%2F=02%7C01%7Caharui%40adobe.com%7C27b04fd07bc545894c30
>>08d564c7bce4%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636525731388973
>>298=Y7ywcVKZa4bZY2RuEGExtUHVfw%2B8Hu6hXTnq%2FYPpQlI%3D=0
>

Re: Images and other assets?

[Gabe Harbs]

I think relative links would work. (Although I could be missing something)

Harbs

> On Jan 26, 2018, at 4:04 PM, Andrew Wetmore  wrote:
> 
> No. All I would need to know is where the website repo is, and how to link
> from the docs to an image stored there.
> 
> On Fri, Jan 26, 2018 at 9:55 AM, Gabe Harbs  wrote:
> 
>> I would assume that images for the website would go in the website repo
>> and doc images would go in the docs repo.
>> 
>> Any reason why that would be problematic?
>> 
>> Harbs
>> 
>>> On Jan 26, 2018, at 3:50 PM, Andrew Wetmore  wrote:
>>> 
>>> Where are we hosting images and other assets for the website in general
>> and
>>> the user documentation in particular?
>>> 
>>> --
>>> Andrew Wetmore
>>> 
>>> http://cottage14.blogspot.com/
>> 
>> 
> 
> 
> -- 
> Andrew Wetmore
> 
> http://cottage14.blogspot.com/

Re: Images and other assets?

[Andrew Wetmore]

Got it, I think.

On Fri, Jan 26, 2018 at 10:04 AM, Andrew Wetmore 
wrote:

> No. All I would need to know is where the website repo is, and how to link
> from the docs to an image stored there.
>
> On Fri, Jan 26, 2018 at 9:55 AM, Gabe Harbs  wrote:
>
>> I would assume that images for the website would go in the website repo
>> and doc images would go in the docs repo.
>>
>> Any reason why that would be problematic?
>>
>> Harbs
>>
>> > On Jan 26, 2018, at 3:50 PM, Andrew Wetmore 
>> wrote:
>> >
>> > Where are we hosting images and other assets for the website in general
>> and
>> > the user documentation in particular?
>> >
>> > --
>> > Andrew Wetmore
>> >
>> > http://cottage14.blogspot.com/
>>
>>
>
>
> --
> Andrew Wetmore
>
> http://cottage14.blogspot.com/
>
>
>
>
>


-- 
Andrew Wetmore

http://cottage14.blogspot.com/

Re: Images and other assets?

[Gabe Harbs]

I would assume that images for the website would go in the website repo and doc 
images would go in the docs repo.

Any reason why that would be problematic?

Harbs

> On Jan 26, 2018, at 3:50 PM, Andrew Wetmore  wrote:
> 
> Where are we hosting images and other assets for the website in general and
> the user documentation in particular?
> 
> -- 
> Andrew Wetmore
> 
> http://cottage14.blogspot.com/

Re: DropDownList with ArrayList

[Gabe Harbs]

Yup. And an Express version should probably use a bead which can handle either 
Array or ICollection dataProviders.

> On Jan 26, 2018, at 3:32 PM, Peter Ent  wrote:
> 
> In PAYG fashion we/you would need to create a new set of beads that work
> with ICollectionView rather than generalizing.
> 
> ‹peter
> 
> On 1/25/18, 5:36 PM, "Gabe Harbs"  wrote:
> 
>> Yeah. Maybe. In my case, I just used Array instead of ArrayList, but that
>> shouldn¹t really be necessaryŠ
>> 
>>> On Jan 26, 2018, at 12:29 AM, Piotr Zarzycki
>>>  wrote:
>>> 
>>> Hi Harbs,
>>> 
>>> I've looked couple of times into the DropDownList from Basic. Maybe it's
>>> time to reorganize things. Add there View, Model, Renderers etc ? I did
>>> that for MDL DropDownList.
>>> 
>>> Thanks, Piotr
>>> 
>>> 2018-01-25 23:18 GMT+01:00 Gabe Harbs :
>>> 
 The dataProvider setter in DropDownList has the following code:
 
   for (i = 0; i < n; i++) {
   opt = document.createElement('option') as
 HTMLOptionElement;
   if (lf)
   opt.text = value[i][lf];
   else
   opt.text = value[i];
   dd.add(opt, null);
   }
 
 Basically, it makes the assumption that the dataProvider is an
 index-accessible object. This is not the case if the dataProvider is a
 collection. In that case, the code should be something like this:
 
   opt.text = value.getItemAt(i)[lf];
   else
   opt.text = value.getItemAt(i);
 
 I¹m not sure of the best way to generalize this.
 
 Thoughts?
 Harbs
>>> 
>>> 
>>> 
>>> 
>>> -- 
>>> 
>>> Piotr Zarzycki
>>> 
>>> Patreon: 
>>> *https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.pat
>>> reon.com%2Fpiotrzarzycki=02%7C01%7Cpent%40adobe.com%7C724d30423d3844
>>> 1d3d2208d564441339%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636525165
>>> 903100864=ZkXTZnuXlNS%2BK3mWSES4ZO2l8BJWRepVkMgxes4FbNM%3D
>>> =0
>>> 
>>> >> reon.com%2Fpiotrzarzycki=02%7C01%7Cpent%40adobe.com%7C724d30423d3844
>>> 1d3d2208d564441339%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636525165
>>> 903100864=ZkXTZnuXlNS%2BK3mWSES4ZO2l8BJWRepVkMgxes4FbNM%3D
>>> =0>*
>> 
> 

Re: DropDownList with ArrayList

[Peter Ent]

In PAYG fashion we/you would need to create a new set of beads that work
with ICollectionView rather than generalizing.

‹peter

On 1/25/18, 5:36 PM, "Gabe Harbs"  wrote:

>Yeah. Maybe. In my case, I just used Array instead of ArrayList, but that
>shouldn¹t really be necessaryŠ
>
>> On Jan 26, 2018, at 12:29 AM, Piotr Zarzycki
>> wrote:
>> 
>> Hi Harbs,
>> 
>> I've looked couple of times into the DropDownList from Basic. Maybe it's
>> time to reorganize things. Add there View, Model, Renderers etc ? I did
>> that for MDL DropDownList.
>> 
>> Thanks, Piotr
>> 
>> 2018-01-25 23:18 GMT+01:00 Gabe Harbs :
>> 
>>> The dataProvider setter in DropDownList has the following code:
>>> 
>>>for (i = 0; i < n; i++) {
>>>opt = document.createElement('option') as
>>> HTMLOptionElement;
>>>if (lf)
>>>opt.text = value[i][lf];
>>>else
>>>opt.text = value[i];
>>>dd.add(opt, null);
>>>}
>>> 
>>> Basically, it makes the assumption that the dataProvider is an
>>> index-accessible object. This is not the case if the dataProvider is a
>>> collection. In that case, the code should be something like this:
>>> 
>>>opt.text = value.getItemAt(i)[lf];
>>>else
>>>opt.text = value.getItemAt(i);
>>> 
>>> I¹m not sure of the best way to generalize this.
>>> 
>>> Thoughts?
>>> Harbs
>> 
>> 
>> 
>> 
>> -- 
>> 
>> Piotr Zarzycki
>> 
>> Patreon: 
>>*https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwww.pat
>>reon.com%2Fpiotrzarzycki=02%7C01%7Cpent%40adobe.com%7C724d30423d3844
>>1d3d2208d564441339%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636525165
>>903100864=ZkXTZnuXlNS%2BK3mWSES4ZO2l8BJWRepVkMgxes4FbNM%3D
>>=0
>> 
>>>reon.com%2Fpiotrzarzycki=02%7C01%7Cpent%40adobe.com%7C724d30423d3844
>>1d3d2208d564441339%7Cfa7b1b5a7b34438794aed2c178decee1%7C0%7C0%7C636525165
>>903100864=ZkXTZnuXlNS%2BK3mWSES4ZO2l8BJWRepVkMgxes4FbNM%3D
>>=0>*
>

Links to sites outside of help docs

[Andrew Wetmore]

Hi:

Peeling this into its own thread.

I looked at index.md and the syntax for popping a new tab does not seem to
work. See attached image, where the "target" instructions appear in the
visible text.

This discussion [1] proffers several solutions, including using just plain
HTML. I have tried that on create-an-application/migrate-an-existing-app/
migrate-from-flex.md. I don't know where to look to verify that that works;
could you check it?

a

[1]
https://stackoverflow.com/questions/4425198/can-i-create-links-with-target-blank-in-markdown

-- 
Andrew Wetmore

http://cottage14.blogspot.com/

Build failed in Jenkins: royale-asjs_jsonly #197

[apacheroyaleci]

See 


--
[...truncated 926.58 KB...]
 [java] WARNING: [http]:24: WARNING - accessing name require in externs has 
no effect. Perhaps you forgot to add a var keyword?
 [java] var net = require('net');
 [java]   ^^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [http]:25: WARNING - accessing name require in externs has 
no effect. Perhaps you forgot to add a var keyword?
 [java] var stream = require('stream');
 [java]  ^^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [http]:252: WARNING - name module is not defined in the 
externs.
 [java] module.exports = http;
 [java] ^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [https]:23: WARNING - accessing name require in externs 
has no effect. Perhaps you forgot to add a var keyword?
 [java] var http = require('http');
 [java]^^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [https]:24: WARNING - accessing name require in externs 
has no effect. Perhaps you forgot to add a var keyword?
 [java] var tls = require('tls');
 [java]   ^^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [https]:84: WARNING - name module is not defined in the 
externs.
 [java] module.exports = https;
 [java] ^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [net]:23: WARNING - accessing name require in externs has 
no effect. Perhaps you forgot to add a var keyword?
 [java] var events = require('events');
 [java]  ^^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [net]:219: WARNING - name module is not defined in the 
externs.
 [java] module.exports = net;
 [java] ^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [os]:112: WARNING - name module is not defined in the 
externs.
 [java] module.exports = os;
 [java] ^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [path]:97: WARNING - name module is not defined in the 
externs.
 [java] module.exports = path;
 [java] ^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [punycode]:74: WARNING - name module is not defined in the 
externs.
 [java] module.exports = punycode;
 [java] ^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [querystring]:66: WARNING - name module is not defined in 
the externs.
 [java] module.exports = querystring;
 [java] ^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [readline]:22: WARNING - accessing name require in externs 
has no effect. Perhaps you forgot to add a var keyword?
 [java] var events = require('events');
 [java]  ^^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [readline]:23: WARNING - accessing name require in externs 
has no effect. Perhaps you forgot to add a var keyword?
 [java] var stream = require('stream');
 [java]  ^^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [readline]:84: WARNING - name module is not defined in the 
externs.
 [java] module.exports = readline;
 [java] ^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [repl]:23: WARNING - accessing name require in externs has 
no effect. Perhaps you forgot to add a var keyword?
 [java] var events = require('events');
 [java]  ^^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 
com.google.javascript.jscomp.LoggerErrorManager println
 [java] WARNING: [repl]:24: WARNING - accessing name require in externs has 
no effect. Perhaps you forgot to add a var keyword?
 [java] var stream = require('stream');
 [java]  ^^^
 [java] 
 [java] Jan 26, 2018 12:20:06 PM 

Re: Help docs ToC and links

[Gabe Harbs]

I’m trying to find my bearings after following lightly for a couple of weeks.

I’m really excited by all the work that’s been going on vis a vis docs lately. 
I think it’s really important work and really glad it’s happening.

How do I view the current status of the work on docs? I see there’s a develop 
branch on the docs repo, but I’m not sure how to actually view that. Is there a 
URL that Jekyll outputs changes to? Is it built locally, and if yes how? How is 
changes actually published by Jekyll to the docs GitHub.io site?

Thanks,
Harbs

> On Jan 26, 2018, at 9:14 AM, Alex Harui  wrote:
> 
> OK, I figured out how to generate the ToC from a JSON file
> (_data/toc.json).  Basically, it is a hierarchical structure.  Each ToC
> entry is a JSON Object with a path property and an optional children array
> of other ToC entries.
> 
> The title and links are pulled from the site information gathered by
> Jekyll, so you won't see ToC entries on the page for entries in the
> toc.json that don't have an actual file.  Which also means that if you
> don't match the path to the actual file name it won't show either.  Make
> sure you have your capital letters and everything correct.
> 
> I also figured you were asleep at this hour so I did the license sweep.
> Make sure you sync up any local working copies before making more changes.
> 
> On 1/25/18, 6:51 PM, "Alex Harui"  wrote:
> 
>> OK, I saw your other email about more ToC changes coming.  I think I am
>> going to try to generate the ToC.
>> 
>> -Alex
>> 
>> On 1/25/18, 6:32 PM, "Alex Harui"  wrote:
>> 
>>> On 1/25/18, 4:11 PM, "Andrew Wetmore"  wrote:
>>> 
 Hi:
 
 I have not been touching the ToC file because it looks very easy to get
 wrong. 
>>> 
>>> Yeah, I was fiddling with the ToC and thinking the same thing.  I'm
>>> wondering how many more changes to the ToC we'll be doing.  If it is just
>>> a few more to implement your proposed ToC, we could just keep the current
>>> way and fix the small things as we find it.  If we think we're going to
>>> be
>>> adding new entries and/or renaming entries, maybe it is worth it for me
>>> to
>>> try to spend a day making the ToC "generate" from the .MD files.  We
>>> would
>>> probably dictate the organization of the ToC in a JSON file, but the
>>> entries would be less error prone.  Maybe like:
>>> 
>>> { "toc": [ "index.md" : [ "welcome/high-level-view.md" : [] ,
>>> "welcome/features-and-concepts.md": [
>>> "welcome/features/as3.md" ...
>>>  "get-started.md" : ["get-started/system-requirements.md" ...
>>> 
>>> Essentially, a hierarchical object that just lists the file names in the
>>> order you want them to appear in the ToC.  I think I can get Jekyll to
>>> generate the ToC by using the page titles.
>>> 
>>> 
>>> 
 I have also not been inserting links from one .md page to another
 because I am not clear whether we are using relative or absolute links
 (not
 sure, for instance, whether there is a performance benefit of one over
 the
 other...).
>>> 
>>> In the .md files, links have to be a full path without the leading slash.
>>> So to link to /welcome/features/as3.md, you would use
>>> 
>>> [as3](welcome/features/as3.html)
>>> 
 
 Also, when we link out from the help docs to another section of the
 Royale
 site, or any other resource, we should pop a new browser window, not
 take
 the reader away from the help docs. Is there a standard way to declare
 that
 when writing a link in markdown? Is it the same as in HTML
 ("target=_blank")?
>>> 
>>> I had to look it up.  The syntax is:
>>> 
 [as3](welcome/features/as3.html){:target='_blank'}
>>> 
>>> I just modified index.md and tested it and it seemed to work.
>>> 
>>> -Alex
>>> 
>> 
> 

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

[Andrew Wetmore]

Good morning.

Least thing first: Does the Apache header absolutely need to be in short
lines with hard line breaks so it takes up so much vertical space in the
file? Please look at test-apache-header.md and see whether the header laid
out on fewer lines and trusting to line wrapping works.

I am fine with your suggestions about where "Hello, World" should be and
how "Developing an application" might play out. However, this does raise
the question of whether this sort of help-docs structure is going to have
an index or other means to locate concepts like "data binding" if it is
tucked down in a larger set of instructions about applications rather than
being a entry itself.

I think the doc structure is still highly fluid and that we need to either
hold off on the ToC until we are closer to alpha-release of the
documentation, or have a less-bulky ToC document. My rough estimate is that
we have stubs for less than 10% of the pages we will eventually have.

On Fri, Jan 26, 2018 at 4:40 AM, Alex Harui 
wrote:

> Hi Andrew,
>
> I took a quick peek at the Adobe doc.  I'm not sure "Development Phases"
> should be the first thing under "Create an application", especially given
> how the Adobe doc says that some of those sub-topics are not phases.
> Also, I think there is more than one way to develop an application.
>
> My temptation is to leave "Hello, World" as the end of the "Get Started"
> section.  Getting "Hello World" to work will prove that you have properly
> installed the SDK.  Then, I would like to suggest tweaking the "Create An
> Application" section to be where we build an app in 10 minutes.  I think
> we should start with "Application Structure"  I will discuss the MVC
> pattern there as an option.  Then the next section would be called
> something like "A (10 Minute) Tutorial" and the sub-topics will be major
> steps towards building an example app.  It will take you through building
> the UI, network access, maybe data-binding, and it will address building,
> debugging, and deploying the example.  It will pick up enough of the
> development phase information that I don't think we'll need a separate
> section for it.
>
> I'm shutting down for tonight so I'll see what your thoughts are when I
> get going again.  I could also draft my version in a branch if you don't
> want to mess with the develop branch right now.
>
> Thoughts?
> -Alex
>
>
-- 
Andrew Wetmore

http://cottage14.blogspot.com/

Re: Royale in 10 minutes (was Re: Proposed table of contents for Royale help documentation)

[Alex Harui]

Hi Andrew,

I took a quick peek at the Adobe doc.  I'm not sure "Development Phases"
should be the first thing under "Create an application", especially given
how the Adobe doc says that some of those sub-topics are not phases.
Also, I think there is more than one way to develop an application.

My temptation is to leave "Hello, World" as the end of the "Get Started"
section.  Getting "Hello World" to work will prove that you have properly
installed the SDK.  Then, I would like to suggest tweaking the "Create An
Application" section to be where we build an app in 10 minutes.  I think
we should start with "Application Structure"  I will discuss the MVC
pattern there as an option.  Then the next section would be called
something like "A (10 Minute) Tutorial" and the sub-topics will be major
steps towards building an example app.  It will take you through building
the UI, network access, maybe data-binding, and it will address building,
debugging, and deploying the example.  It will pick up enough of the
development phase information that I don't think we'll need a separate
section for it.

I'm shutting down for tonight so I'll see what your thoughts are when I
get going again.  I could also draft my version in a branch if you don't
want to mess with the develop branch right now.

Thoughts?
-Alex

On 1/25/18, 4:07 PM, "Andrew Wetmore"  wrote:

>Hi:
>
>I think the "Royale in 10 Minutes" goes where the ToC "Hello, World!" is
>in
>the "Get Started" section. I saw the "Create an Application" section as
>what you would turn to when you had gone through building a first little
>application and decided, yes, maybe this Royale is the thing I need for
>what I want to build.
>
>I took the "application lifecycle" lineup from the old Adobe Flex help doc
>structure [1] section "Application Architecture / Application development
>phases". Of course, the under-the-hood tick-tock of what happens in a
>Royale app when you run it is equally valuable, but different. Feel free
>to
>use "Application Lifecycle" to describe what you want to write about, and
>we can change the top title for my stack to something like "Application
>development phases", as you suggest.
>
>Each night I wake up at least once thinking something like, "Oh, I forgot
>an entry for Events!" The ToC is far from complete!
>
>I have added the info about the Apache header in README.md, which I take
>to
>be the place where documentation contributors would look for guidance.
>Just
>pick a time and let me know and I will be out of the way for your sweep
>through the existing files. I am in Nova Scotia in Canada, four hours
>ahead
>of you if you are on the West Coast.
>
>a
>
>
>[1] 
>https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fhelp.adob
>e.com%2Fen_US%2Fflex%2Fusing%2Findex.html=02%7C01%7Caharui%40adobe.co
>m%7Cadede60163a34be4055d08d56450c920%7Cfa7b1b5a7b34438794aed2c178decee1%7C
>0%7C0%7C636525220508068194=oQoLgTo6SzY9yZONTU7VFB7Ldy8i2bwNctmMmAjrn
>%2B4%3D=0
>
>
>On Thu, Jan 25, 2018 at 7:14 PM, Alex Harui 
>wrote:
>
>> Hi Andrew,
>>
>> So I just pushed more stubs for the Create An Application section.  As I
>> was doing so, I started thinking that what you expect in that section is
>> different from what I'm interested in working on.  It isn't that we
>>don't
>> need that section, but it appears that you want to address application
>> development as a general topic, discussing the design phase, and
>> maintenance phases, etc.
>>
>> What I want to write is a "Royale in 10 minutes".  Sort of a tutorial
>>for
>> building something more than a Hello World, and discuss some
>> "under-the-hood" things like how the app starts up, how you know the app
>> is ready, calling a web service, stuff like that.  If you agree we want
>> such a thing, where would it go?
>>
>> Also, we have to be a bit careful about terminology.  The reason I
>> initially thought that I would do the "Royale in 10 minutes" in the
>> "Create an Application" section is because one subsection is titled
>> "Application Lifecycle".  To me, that meant the under-the-hood lifecycle
>> of an application like what its entry point is, what gets initialized
>> first, etc.  I'm tempted to rename the current "Application Lifecycle"
>>to
>> "Application Development Phases" so I can use "Lifecycle" for the
>> under-the-hood section.  Or is there a better name for how an
>>application
>> starts up?
>>
>> I'm going to go spend some time on ASDoc while we figure this out.
>>
>> Also, at some point, we should sweep through all of the files and add
>>the
>> Apache header to them.  I did it in "Create an Application.md" to make
>> sure it didn't pollute the output.  I didn't do the sweep now since I
>> didn't know if you have files under edit.  I'm not sure what hours you
>>are
>> working on this, so we should just pick a time where we have everything
>> committed and do a sweep.  I could do it on my Sunday night on the US
>>west
>> coast.
>>
>>