Return to Authoring_Daxe_FAQ.tex CVS log

Up to [LON-CAPA] / loncom / html / adm / help / tex

Annotation of loncom/html/adm/help/tex/Authoring_Daxe_FAQ.tex, revision 1.2

1.1       raeburn     1: \label{Authoring_Daxe_FAQ}
                      2: 
                      3: \textbf{Daxe Editor -- Frequently Asked Questions}
                      4: 
                      5: \begin{description}
                      6: 
                      7:   \item[\textmd{\normalsize\textit{Is Daxe compatible with the other LON-CAPA editors?}}]
                      8: 
                      9: It should be. But a conversion is needed before a document can be loaded into Daxe, 
                     10: and a conversion is done afterwards to match the syntax of the other editors.  
                     11: So it is possible that the initial conversion fails, and it is possible that the syntax 
                     12: or spacing is altered in some ways. Still, this should not change the output.
                     13: 
                     14:   \item[\textmd{\normalsize\textit{Which browsers are supported?}}]
                     15: 
                     16: Recent versions of all browsers, on all platforms.  
                     17: This constraint is related to the technology used to create Daxe, which is Dart. No plugin is needed.
                     18: 
                     19:   \item[\textmd{\normalsize\textit{What is an element?}}]
                     20: 
                     21: ``element'' is a technical term related to the XML syntax used by Daxe.  
                     22: It refers to a part of the document, starting with a start tag and ending with an end tag.  
                     23: A hierarchical structure can be created by putting elements inside other elements.  
                     24: The tags are usually hidden in LON-CAPA Daxe (a whole element being often represented as a box),
                     25: but you will see them if you look at the XML source with the File menu.
                     26: 
                     27:   \item[\textmd{\normalsize\textit{What is an attribute?}}]
                     28: 
                     29: An attribute is a property of an element. It has a name and a value.  
                     30: For instance, the \texttt{img} element (which represents an image) has a
                     31: \texttt{src} attribute which gives the path to the image file.
                     32: 
                     33:   \item[\textmd{\normalsize\textit{How do I select an element?}}]
                     34: 
                     35: The easiest way is to double-click on the title when there is one, 
                     36: but you can also click before the element, hold and drag until after its end.
                     37: 
                     38:   \item[\textmd{\normalsize\textit{How do I move an element?}}]
                     39: 
                     40: Select it, cut it with \texttt{ctrl-X}, and paste it where you want with
                     41: \texttt{ctrl-V}.
                     42: 
                     43:   \item[\textmd{\normalsize\textit{How do I remove an element?}}]
                     44: 
                     45: The easiest way is to do a right-click on the title and choose ``Remove''.  
                     46: But the \texttt{backspace} or \texttt{del} keys can be used too.
                     47: 
                     48:   \item[\textmd{\normalsize\textit{Why is Daxe sometimes not selecting parts of elements?}}]
                     49: 
                     50: Daxe is only doing operations that keep the document syntax correct.
                     51: So, it will not for instance select a start tag without the end tag, 
                     52: because doing operations on a single tag could break the whole document.  
                     53: But if you start a selection before a start tag, and continue 
                     54: until after the end tag, the whole element will be selected.
                     55: 
                     56:   \item[\textmd{\normalsize\textit{How can I insert a movie or sound?}}]
                     57: 
                     58: Use the HTML5's \texttt{video} or \texttt{audio} element (in the HTML-Media menu),
                     59: with the path to your previously uploaded video/audio file in the \texttt{src} attribute,
                     60: and for a video the dimensions in pixels in the \texttt{width} and \texttt{height} attributes.
                     61: 
                     62: Remember that not all browsers support all formats, so it is actually better to provide 
                     63: several files with the \texttt{source} element instead of using the \texttt{src} attribute.
                     64: 
                     65:   \item[\textmd{\normalsize\textit{My Perl script does not seem to be running ...}}]
                     66: 
                     67: Make sure you are using the right \texttt{type} attribute.
                     68: If a script has no \texttt{type} attribute, it is assumed to be Javascript.
                     69: 
                     70:   \item[\textmd{\normalsize\textit{My math is not looking great in the preview ...}}]
                     71: 
                     72: The preview uses the default math display engine for your domain (which may not be MathJax),
                     73: unless you have set your own user preference which overrides the default.
                     74: 
                     75:   \item[\textmd{\normalsize\textit{What is the validation (in the File menu) checking?}}]
                     76: 
                     77: It checks that the elements used in the document really exist in the language, 
                     78: and that each element inside a parent is allowed under. It also checks for the 
                     79: order of the elements when there is a constraint about that, 
                     80: but it is rare with LON-CAPA. It also checks for the syntax of each attribute.
                     81: 
                     82: The fact that a document validates does not mean that it will run well in LON-CAPA.  
                     83: For instance, there might be an error in a Perl script which will only be caught 
                     84: when it is executed. But it helps to create documents that will run well everywhere.
                     85: 
                     86:   \item[\textmd{\normalsize\textit{How do I change options for the preview?}}]
                     87: 
                     88: It is not possible within the Daxe page, but you can use the ``Problem Testing'' display
1.2     ! raeburn    89: of the problem, e.g., by expanding the LON-CAPA menu block (if collapsed) and then 
1.1       raeburn    90: pushing the ``Save and View'' button to try different preview options.
                     91: 
                     92:   \item[\textmd{\normalsize\textit{Can I copy/paste source code between Daxe and the LON-CAPA text editor?}}]
                     93: 
                     94: No ! The two editors are using a different syntax. 
                     95: Daxe is using the XML syntax, while the text editor is using a LON-CAPA-specific syntax.  
                     96: For instance, XML special characters are encoded inside m elements and attribute values with Daxe, 
                     97: but that syntax would not work in LON-CAPA without a conversion.
                     98: 
                     99: So if you need to reuse source code from Daxe with the text editor, save the document, exit Daxe, 
                    100: and open the problem with the text editor before copying code.
                    101: 
                    102:   \item[\textmd{\normalsize\textit{How can I get the response field on the same line as the question?}}]
                    103: 
                    104: Paragraph tags are hidden in the editor, and a paragraph is just indicated with a gray 
                    105: \P mark on the lower right. If a response appears on a different line in the preview, 
                    106: it might be because it is in a different paragraph, or outside of a paragraph.  
                    107: To move the response in the paragraph with the question, one can select it, cut it, 
                    108: and paste it after the text in the previous paragraph. The \P mark will appear on the 
                    109: lower right of the response. Note that this is only possible with some responses, 
                    110: since other responses display as blocks and cannot be put inside a paragraph.
                    111: 
                    112: \end{description}