markbind / markbind Goto Github PK

May be better to choose one of the three and use it for all three cases?

When I update a question, it's hard to get the live update to load the latest version of the question. It keeps showing the previous version of the question content.

example: http://127.0.0.1:8080/site-demo-cs2103/book/requirements/userStories/

Currently: todo, tutorial, etc.
Suggested: blue, orange, red, etc.?

If I open _site/index.html file in a browser, the navbar link to textbook doesn't work.

Here is the code:

<popover placement="bottom" title="**GoF book**">
  <div slot="content">
    This is a long content...
    <pic src="introduction/book-designpatterns.jpg" width="400px">
  </div>
  :flashlight:
</popover>

<p>

<Panel header="Above description is too abstract? Here is an illustrative example :zero:" 
  expandable type="seamless">
  <include src="../singleton/index.md" />
</Panel>

I'm trying to insert some space above the panel using <p>, but instead it auto-expands the panel.

Nested closeables work together. e.g. closing the inner closeable closes the outer closeable.

This is what I'm trying to achieve. The current popover needs some enhancements before we can achieve this level.

On the code side, something like this would be ideal but not sure how close we can get.

These solutions are collectively known as _design patterns_, a term popularized 
by the seminal book *Design Patterns: Elements of Reusable Object-Oriented Software* 
the so-called {{“Gang of Four”}}(gof-tip) (GoF): Eric Gamma, Richard Helm, 
Ralph Johnson and John Vlissides. 

Somewhere else in the file ...

<popover-content id="gof-tip">
<pic src="introduction/book-designpatterns.jpg" width="400px">
Lorem ipsum dolor sit ...
</popover-content>

OR

<popover-content id="gof-tip" src="gof-tip.md"/>

In some cases inline text expansion can be helpful.

Unlike tool tips or popovers, text expanded inline can be included in the printout.

e.g. create a course website that reuses content from multiple books (each book is a separate repo)

It may be useful to have more optimized support for closeable blocks. For example, the x can be shown at the right edge instead of the left edge

The current font size makes block quotes stand out more than the regular text.

Ideally, they should be the same size as normal text.

Sometimes when I save changes in the editor, live preview goes into 'loading' mode (blank web page) and stay there.
No errors are shown in the CLI console.

Allow a page to have a nav-bar/ToC, preferably, with auto-generated links.

Adding the following to sites.json required a restart of the server to see the page http://127.0.0.1:8080/site-demo-cs2103/book/common/References.html.

    {
      "src": "book/common/References.md",
      "title": "CS2103/T Textbook - References"
    }

When the Singleton pattern is included dynamically in the week 2, this image is not showing up.

The generated website (i.e. _site) seem to contain .md files and .json files. I'm not sure if they are needed to be there.

Panel headers like this should be omitted from printing?

If expanded, the content should be printed but this heading should be omitted.

Not sure if that is possible though.

If a file root/aaa/bbb/page.md contains a link [details](details.md)
and it was included in root/toc.md
the generated link in toc.html should be aaa/bbb/details.html?

When a popover is triggered by a <trigger> (example given below), honor the trigger="..." setting. The current one defaults to hover no matter what the setting is.

According to <trigger for="pop:xp-user-stories">XP</trigger>, the biggest difference

<popover id="pop:xp-user-stories" trigger="click">
  <div slot="content">
    <include src="../../common/References.md#xp-user-stories" />
  </div>
</popover>

It would be useful to have a subtle indication of the bottom of the panel (when expanded). Otherwise it's hard to see where the panel content ends and the rest of the page content begins.

A grey dashed line?

In dotted underline doesn't appear in cases like this:

<trigger for="pop:trigger_id">`Logic` class</trigger>

tipbox --> box?

https://www.webpagefx.com/tools/emoji-cheat-sheet/

It would be nice if we can support :one: :zero: etc because I hope to use them show the depth of a topic. Numbers are preferable than stars due to their fixed width.

However, even github doesn't seem to support them.
What is the possibility of supporting custom emojis?

It's nice if the reader can minify/hide some parts of the page (e.g. videos, pictures, ...) before printing the contents.

To be used for marking definitions.

Repeating tool tip everywhere the term is used is redundant. Inline definition of tooltips breaks the flow of the content.
The ideal is to be able to write something like this and the code to pull the definition from a standard location such as root/definitions.md.

When we want to reduce {{coupling}}, we should ...

Here is an example:

Compared to how the same question appears in a normal panel

For example, let's say I'm tweaking the 'Singleton pattern' part of the text book? How do I load just that page inside the browser?

In some cases we need to include other types of panels inside a seamless panel

When panels are nested, it is good if we can override the style of inner panels

Updated description:

Justification: It allows to easily 'quote' a part of the page.

Current: One can refer to a specific location of a page e.g., http://abc.com/page.html#location

Problem: This technique can only show where to start reading, not where to stop.

Suggested: Give a way to be able to quote (or highlight) a section of a page e.g., http://abc.com/page.html?show=section-id which will show either the indicated section of the page only or show the full page but highlight the indicated page in some way

This feature can be useful to readers as well as authors.

Allow floating elements (for example images) to the right/left/center, ... for layout purposes

No need to show the hint panel if the question does not specify a hint

Explore if there is a need for both tooltip and popover and if the answer is no, eliminate tooltip.

Otherwise user has to scroll to the top of the panel to collapse it.

Support different types of blocks for warnings, additional info, important points, etc.

For some simple question types (essay, mcq, check-boxes), allow user to enter their answer before checking the answer. It will allow reader to record their answer temporarily before comparing it with the given answer.

Currently we use block quote formatting to show text in bigger size. This is an abuse of syntax. Instead, we should tweak the block quote formatting to actually look like quotes as we do have an actual use case for showing quotes in our eContent.

On the other hand, we could support an easy syntax to indicate whether to make text bigger/smaller relative to the default size. e.g. +++ ---

This space is not inside the trigger text, but is underlined.

e.g. %%dim text%%

This doesn't work

* [Design Patterns](book/se-pattern/) 
  <morph title=":mag:">
  <div>
  A software _design pattern_ is a general reusable solution to a commonly occurring problem within a given context in 
  software design. 
  This chapter covers:
  * An intro to design patterns
  * Some common design patterns
  
  :mag:
  
  </div>
  </morph>

I have this code in a file. When I include it in another place, the content of the morph element appears outside of the element.

* [Design Patterns](book/se-pattern/)
  <morph title=":mag_right:">
    <div>
  
A software _design pattern_ is a general reusable solution to a commonly occurring problem within a given context in 
software design. 

This chapter covers:

* An intro to design patterns
* Some common design patterns

    </div>
  </morph>

In the example below, the word coupling is the one that has a tooltip

Code:

An example problem about the interaction between classes: how to lower the 
  <tooltip content=" coupling is the degree of interdependence between software modules; a measure of how closely 
  connected two routines or modules are; the strength of the relationships between modules.">coupling</tooltip>
  between UI and Logic classes?

Other things:

• Tip text is better to be left-aligned by default?
• We need a way to indicate the tool-tipped text e.g. a grey dash underline (similar to the one given in #11 )

When I use the following code, the second inner panel appear outside of the outer panel.

<panel header="outer" expandable type="seamless">
  <panel header="inner1" expandable type="seamless">
  
line1<br>
line2
    
  </panel>
  <panel header="inner2" expandable type="seamless">
    content 
  </panel>
</panel>

However, the problem can be avoided if I use <br/> instead.

Currently, a partially loaded page with messed up content is shown when a page is loading. May be show a spinner during loading?

We should consider collapsing different types of panels (dynamic, morph, etc.) into one 'super' panels.
e.g.

<panel src="/docs/loadContent.html" title="some title" 
    expandable collapsed|expanded|minimized type="seamless|primary|warning|...">

</panel>

The presence of src indicates it is a dynamic panel.
A panel can have icons to expand, collapse, minimize, and expand all.

The slides show either garbage or blank space unless the browser is logged into one drive.