Git Product home page Git Product logo

dotvvm-docs's Introduction

DotVVM Documentation

This repository contains the DotVVM documentation. If you find any problems, mistakes or inaccuracies, please go ahead and submit a pull request.


Contributions

Currently, we don't have any tool to preview changes made to the documentation. Just edit some files, or create new documentation pages or control samples, and submit the pull request. We'll review and finish it ourselves before it gets published.

Please, always do your changes against the 2.0 branch. We'll merge the changes in all other branches where they should appear.


File Structure

The menu.xml file defines the structure of the left menu. The Pages directory contains all tutorial pages.

The Controls section contains everything that is used to generate the control reference. Currently, there are two categories of controls - builtin for DotVVM controls built in the framework itself, and bootstrap for our commercial controls.

Each control category contains two files - doc.xml which is documentation XML file and metadata.json file which is generated by our internal tool and contains a list of controls and all their properties with all information we need to render the control table.

Then, each control has its own folder, which contains the control.md file which describes the control. Optionally, there is the output.md file, which describes HTML rendered by the control.

Each control can have one or more samples which are placed in subfolders named sample1, sample2 etc. Each subfolder must contain the sample.md file with description of the sample. Then, there is a sample.json file with list of all files that should be displayed as part of the sample.

dotvvm-docs's People

Contributors

acizmarik avatar adamjez avatar bkapustik avatar cafour avatar cristiant avatar djanosik avatar duzij avatar exyi avatar geniusk avatar jaroslavholcman avatar jonismarek avatar josefpihrt avatar kiraacorsac avatar lixfeld avatar luko248 avatar marosjanota avatar martindybal avatar mateshavel avatar michaltichy avatar mitroz avatar mrnustik avatar mylan719 avatar ondrejvrsan avatar padresvk avatar quigamdev avatar ropack avatar rumbeer avatar sejsel avatar tomasherceg avatar tomasjurasek avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

dotvvm-docs's Issues

Errors in docs for Bootstrap 4 controls

I discovered some errors in documentation for Bootstrap 4 controls.

ListGroup

https://www.dotvvm.com/docs/2.0/controls/bootstrap4/ListGroup

Sample 5: Badges
There is typo "USe".

Popover

https://www.dotvvm.com/docs/4.0/controls/bootstrap4/Popover

Sample 6: Popover Template
The image inside the popover is missing.

Badge

https://www.dotvvm.com/docs/4.0/controls/bootstrap4/Badge

Sample 3: Badge as Link or Button
Sample does not show anything.

Breadcrumb:

https://www.dotvvm.com/docs/4.0/controls/bootstrap4/Breadcrumb

Sample 1: Static Breadcrumbs
Sample does not show anything.

Sample 2: Selected Items
Sample does not show anything.

Specification of routing syntax and semantics

We should create a precise specification of dotvvm routing behavior. It should consist of (informal) grammar of the syntax, how will that behave and some examples explaining it. Documenting extensibility points (custom constraints, custom routes...) may be a good idea.

Update docs for DotVVM 2.0

Review

  • Resources
  • Route registration
  • DotVVM registration (app.UseDotVVM and app.AddDotVVM)
  • Postback Handlers (TranslateValueOrBinding, js api)
  • Concurrency Mode
  • Repeater and GridView docs (_collection, _index, etc.)
  • IoC/DI Containers
  • MiniProfiler (owin registration)
  • Embedded resource registration (markup control, dothtml page)

etc.

Update README.md to reflect current branches

The readme mentions a latest branch that people should commit to even though there is currently no latest branch.

Please, always do your changes against the latest branch. We'll merge the changes in all other branches where they should appear.

LinkButton Sample #2 probably not what intended

The ViewModel contains Switch() func that negates the Enabled prop, however the Enabled prop is bound to the button that fires of the Switch(), therefor rendering the Switch() callable only once.

The probable intended behavior was to only bind the Enabled prop to the other two buttons, so the first button can repeatedly disable and enable them.

Wronk link in docs

Link to built-in GridView in bootstrap GridView page throw 404 error.

Some errors in docs

Hello,

First of all I would like to say that your documentation is very good and thorough.

Nevertheless I encountered some minor issues:

  1. RangeSlider looks weird in the example here: https://www.dotvvm.com/products/dotvvm-business-pack

image

  1. It is not possible to finish last tutorial in the academy "Basic validation". During the last but one step the there is an error (even if the user clicks "Show solution").

image

  1. Page "Access validation errors from JS" is empty.

https://test.dotvvm.com/docs/4.0/pages/concepts/client-side-development/access-validation-errors-from-js

I used latest Chrome browser.

Common control properties

Common control properties has a control named IncludedInPage which does not work, however IncludeInPage does work

InvalidCssClass property doesn't convert correctly to html

test code:
<dot:Validator Value="{value: MyValue}" InvalidCssClass="error" > !!! </dot:Validator>

and the html code is:
<span data-bind="dotvvmValidation: MyValue, dotvvmValidationOptions: { 'hideWhenValid': true, 'ınvalidCssClass': &quot;error&quot; }" style="display: none;"> !!! </span>

because of ınvalidCssClass (not invalidCssClass) an error is displayed at console tab:

knockout:75 Uncaught TypeError: Unable to process binding "dotvvmValidation: function(){return MyValue }"
Message: dotvvm.validation.elementUpdateFunctions[o] is not a function
    at d.applyValidatorOptions (dotvvm--internal:1)
    at update (dotvvm--internal:1)
    at a.N.l (knockout:75)
    at Function.dd (knockout:54)
    at Function.ed (knockout:53)
    at Function.ea (knockout:53)
    at Object.a.u.a.N (knockout:51)
    at knockout:75
    at Object.D (knockout:12)
    at k (knockout:74)

There is a problem with translating capital I into lowercase letter i
at Elements tab if i change "ı" to "i" code works.

image
image

Exception when use resource and last character is &

When I want to show any string in page as resource and last character of this string is & I get exception Index was outside the bounds of the array. When I use value instead of resource it is ok. Similarly, if the character & is not at the end but in the middle or at the beginning, everything seems fine.

Steps to reproduce:

View model:
public string Test { get; set; } = "test string &";

dothtml:
<dot:Literal Text="{resource: Test}" />

The information about upgrading to the business package etc doesn't seem to work and is out of date

This is regarding: https://www.dotvvm.com/docs/3.0/pages/dotvvm-for-visual-studio/dotvvm-private-nuget-feed#sign-in-to-add-the-feed-automatically

The automatic feed registration doesn't work neither does the automatic install of the packages.

I got it working via the private nuget feed however I used the instructions here:

https://docs.telerik.com/reporting/add-the-telerik-private-nuget-feed-to-visual-studio

Basically in the nuget settings option in the nuget manager. Add the URL as a new source then when the username and password is asked for enter it and choose the save password option.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.