API – 3WDOC FAQ

Here are the most common questions that you may ask yourself about the 3WDOC Studio. If you are looking for more visual explanations, please have a look to our tutorials in the Support section.
A French and Spanish version of these FAQs and Tutorials section will be ready soon.

Things you have to know before starting

3WDOC Studio allows you to create new type of contents: rich media linked in a story.

What is a Sequence?

A sequence includes your edited work. It is composed of one track or an unlimited number of tracks. Your story, or a part of your story, can be told in a sequence. By analogy, a sequence could be the equivalent of a chapter in a book where lines would be tracks!

What is a track?

A track is each element added in the sequence. Tracks can be medias (photos, audios, videos), articles and buttons. Each track will be placed on time and space.

What is the 3WDOC Editor?

The 3WDOC Editor is the workspace of each sequence. You will build your story by selecting the different items (medias, articles and buttons), editing them, giving them a duration and placing them on space (the screen).



What is a WDOC?

A WDOC is the final production composed of different sequences in order to tell a complete story.
A WDOC could be the equivalent of a book.

What are the formats I can use for images?

You can use images with these extensions: .jpg, .png, .gif.
The maximum filesize is 50Mo.

What are the formats I can use for videos?

For each video file you will have to create 2 files, one in .mp4 extension and the second one in .ogg extension.
3WDOC STUDIO needs these 2 formats to ensure the video will be interpreted by all modern browsers.
The maximum filesize is 50Mo.

What are the formats I can use for audios?

For each audio file you will have to create 2 files, the first one in .mp3 extension and the second one in .ogg extension.
3WDOC STUDIO needs these 2 formats to ensure the audio will be interpreted by all modern browsers.
The maximum filesize is 50Mo.

What is the limit for free hosting offered by 3WDOC?

The free hosting offered by 3WDOC is limited to 1Gb per user

What is the maximum filesize?

The maximum size of a media is limited to 50 Mb

How do I get started? In 4 steps!

A small initiation of what are the requirements to start on the good foot.

How do I upload a media?
  • From your computer: Media > Create : Media Upload window
  • or

  • Link your media straight from the web


How do I import a video from the web?

Go to 3WDOC STUDIO: Add a video track, and copy paste the link in the inspector. Be careful, you have to withdraw the extension from the filename; and do not forget to upload two files, one in .mp4 and the other in .ogg in order to be cross-browser.

How do I create a sequence?

Sequence > Create: Sequence Edit window:
There are 3 fields filled by defaut:

  • Width: 960 px
  • Height: 640 px
  • These parameters will allow you to display the sequence in 4:3 full screen.

  • Autoplay: TRUE (the sequence launches automatically)

Don't forget to enter the Label (the name).
You can also fill other fields: Description, Tags, ...

> Close the window. You are in the 3WDOC STUDIO of the created sequence. You can start editing.

What is the recommended size for a sequence?

To optimize your sequence in the browser, go to Sequence Edit and enter these parameters:

For a video with a 16:9 aspect ratio

  • Width: 960 px
  • Height: 540 px

For a video with a 4:3 aspect ratio

  • Width: 960 px
  • Height: 640 px
How do I get a full screen?

If you wish a full screen size for your WDOC, go to Sequence Edit and enter these parameters:

  • Width: 960 px
  • Height: 540 px (for 16:9) or 640 px (for 4:3)
  • Native Window: FALSE
  • Ratio Window: 0
How do I manage Autoplay value?
  • If you enter "TRUE", the sequence will play automatically without any action of the user.
  • If you enter "FALSE", the sequence will be static, which means that all the elements will be permanently visible (as an average website).


How do I publish a sequence?
  • Save your sequence (clicking on the Save button on the main menu of the sequence).
  • Preview it to be sure you are satisfied with the result (clicking on the Preview button on the main Menu).
  • Just click on the Publish button. And that's it!

Click on Home button in the main Menu of 3WDOC Studio, to access to My Stories. All your published sequences and WDOCs are here.
You will be able to access to each one directly, and to share them on Facebook and Twitter.

How can I create and publish a WDOC?

WDOC > CREATE.

  • Fill the Label.
  • Go to Active Field and select TRUE. This action will publish your WDOC.

In the Sequence List, select each sequence to assign to this WDOC: in Sequence Edit select the Webdocument_id of this WDOC.

How do I work?

A way to start editing.

How can I add a track?

Add track Select the element you want to add (audio, video, article, image or button) click on Add track.
The track will be automatically created and visible on the Timeline. Each track can also be visible on the Positioner.
Each new track will be placed at the end of the Timeline.

What is the Timeline for?

It allows you to show and edit all the tracks on time.
Just click on the track to change its duration or to move it on time.

How can I duplicate my track?

You can duplicate your track easily.
On the Timeline, select the track you want to copy and click on the "double sheet" icon.

Why different colors of tracks?

In the Timeline, we have attributed different colors to help you to recognize each type of track.

- Blue corresponds to a button.

- Green corresponds to an image.

- Red corresponds to a video.

- Yellow corresponds to a sound.

- Pink corresponds to an article.

What is the Positioner for?

You can move the track with your mouse and place it where you want. You can also change its size.
At any moment, you can decide wich track will be shown on the Positionner by the check-box on the Timeline.

What is the Inspector for?

It allows you to edit each track, by these tabs: Informations, Properties, Effects, Actions and Style.



What are the actions I can apply?

TcLink, TcGoto, TcOverlayed, Native action, ...



An image could have an action?

Yes it can! Go to the Inspector > Action.

What are the effects I can apply?

Blind, Clip, Fade, Slide, Bounce, ...



How do I edit my sequences?

Edit some sequence parameters.

Can I copy a sequence?

You can copy a previously created sequence. It will enable you to have the same "screen", the same structure, and you will just have to change its medias.



How can I create a general menu to go to different sequences?

You have to create a new sequence, with buttons that will link to different sequences.
Each button will have an action TCLink. Then click on Select to select the targeted sequence.

How can I link 2 sequences?

You can link 2 sequences between them with a TcLink action on a button.
Insert a button on your sequence, give it the action TcLink and click on SELECT to select the targeted sequence.

How can I share a sequence?

Click on Home button in the main Menu of 3WDOC Studio, to access to My Stories. All your published sequences are here.

  • Click on Facebook icon to share the sequence on your wall
  • Click on Twitter icon to share the sequence on your tweet account
Can I work on 2 sequences at the same time?

No, you can only work on 1 sequence.
If you are editing one sequence and you decide to open a second one, the first one will be closed automatically.

At what size will my sequence be shown?

In Sequence Edit check these parameters:

  • Native Window
    TRUE: It will show your sequence at the chosen size
    FALSE: It will allow you to change the size of your sequence's appearance in the browser.
  • Ratio Window
    It is active only if you have enter "FALSE" in Native Window field.

    If you enter "0", the sequence will be shown in full screen.
    If you enter "0.5", it will show half of the size of the sequence.
    If you enter "2", it will double the size of the sequence.

What is the Style for?

It will enable you to create and apply different styles to your items.

How do I create a Style?

Style > Create: You are in the Style Editor:
* See more on "How do I edit a Style?"

> Click on CONFIG icon
Don't forget to enter the Label. You can also enter the Description, the Tags, ...

How do I edit a Style?

Go to Style Editor and select the element you wish to style: Background, Player Position, Article, Button, Image, UI Botton and UI color.



How do I apply a Style?
  • A style is always linked to a sequence.
  • Go to Sequence Edit: Skin_id, and select the Style you want to affect.

  • Select the track that you want to style, for instance a button
  • Go to the Style tab on the Inspector and select a style for the button.

* Videos and audios cannot have a style.

How do I manage?

A proper way to organize your workflow.

What is the Media List?

It's a list of your uploaded medias.
You can manage your medias and upload new ones. Each media is represented by: ID, icon of your type of media, label, date of upload and tags.
Each media can be duplicated, deleted, visualized, and edited.

What is the Sequence List?

It's a list of the sequences you have created.
Each sequence is represented by: ID, icon, label, date of upload, and tags.
Each sequence can be duplicated, deleted, and edited. It also gives direct access to the 3WDOC Editor.

What is the WDOC List?

It's a list of your WDOCs. You can edit them and create new ones.
Each WDOC is represented by: ID, icon, label, date of upload, and tags.
Each WDOC can be duplicated, deleted, and edited.

Go further with 3WDOC Editor

Some clues …

How to create a video on overlay?

The media don't have a temporality on overlay. You will have to create a button to be able to launch the video.

  • Add a video track and give it a label. On its Properties, enter 0 in start and 0 in stop.
    In Actions, choose TcOverlayed and define a value (like a keyword, for example "my-video").
  • Add a button track and give it a label. In Actions choose TcOverlay and enter the same value that you defined for the video ("my-video").
    Select the event for the action of your mouse (click/hover)

How can I insert a UI button like “play, pause, fwd,…”?

You have to create a button with the Action Native action.
In Value you can choose between Ctime (to put up a stopwatch), Fwd (to forward on the timeline), Mute (put the sound off), Pause, Play (launch the sequence), Rwd , Screensize, Sndminus (lower the volume), Sndplus(increase the volume), Stop. In Type, select UI.
(These termes come from the JQuery feature)

Is my content visible in any browser, tablet or smartphone?

HTML5 is a new language so there are some points to be aware of.

What browsers are best for 3WDOC Studio?

We recommend you to use the last version of each browser, although all these versions are compatible:

  • Safari: 4.1 and +
  • Firefox: 3.5 and +
  • Opera: 10.6 and +
  • Google Chrome: all versions
  • Internet Explorer: versions 6, 7, 8 and 9. Internet Explorer users will have to install the Google Chrome Frame plugin for an accomplished view of WDOC.
Can I show my WDOC on iPad?

You will be able to watch a WDOC from an iPad. 3WDOC has, so far, some limits that you need to know:
The videos and audios placed on a timeline (having a duration), won't be displayed.

What is the alternative?
You will be able to watch videos and audios on overlay. This means that you will have to create a button to activate this action. (Go to "How to create a video on overlay?")

How can I manage my account?

Some questions about your account.

How to permanently delete your 3WDOC account?

For the moment there is no automatic procedure, you can only drop us a mail to info@3wdoc.com to ask to delete your account and it will be done.

Troubleshooting

What if (some troubleshootings)

Why am I disconnected from the 3WDOC Studio?

There is limited connection time if you are not doing anything in the 3WDOC Studio. You will be disconnected after an average time of more or less 25 minutes.

Why do I have to refresh the browser or empty cache to see changes?

Like for any webpage, we advise you to empty the cache of your browser for time to time. After a Save action before clicking on the Preview button, empty the cache in order to visualize the modifications.
If after this action you still don't preview any change, refresh the browser.

I have registered my domain and install the 3WDOC Studio at this domain, but it does not work…

One thing to remember is that if you register for instance www.mydomain.com as your domain and install the 3WDOC Studio at www.mydomain.com/my-studio/, you will have to access it by this exact address.
If you try to access to it by mydomain.com/my-studio/ it will not work, because it is ANOTHER DOMAIN.

I have an error in the background image displayed for the buttons?

In light of developments browsers, you can sometimes experience differences in terms of display. This is not strictly speaking a bug even if it has the appearance. It is an error display background images on the “hover” buttons, ie when the mouse moves over these buttons, the image can not be found. This display error [...]