Home.purs 15.1 KB
Newer Older
1
module Gargantext.Components.Nodes.Home where
2

3 4
import Gargantext.Prelude

5
import Data.Maybe (Maybe(..))
6
import Data.Newtype (class Newtype)
7
import Effect (Effect)
arturo's avatar
arturo committed
8
import Gargantext.Components.App.Store (Boxes)
9
import Gargantext.Components.Data.Landing (BlockText(..), BlockTexts(..), Button(..), LandingData(..))
10
import Gargantext.Components.FolderView as FV
11 12 13
import Gargantext.Components.Lang (LandingLang(..))
import Gargantext.Components.Lang.Landing.EnUS as En
import Gargantext.Components.Lang.Landing.FrFR as Fr
14
import Gargantext.Components.Nodes.Home.Public (renderPublic)
15
import Gargantext.Config as Config
16
import Gargantext.License (license)
James Laver's avatar
James Laver committed
17
import Gargantext.Sessions (Sessions)
Alexandre Delanoë's avatar
Alexandre Delanoë committed
18
import Gargantext.Sessions as Sessions
19
import Gargantext.Sessions.Types (Session(..), cleanBackendUrl)
20
import Gargantext.Utils.Reactix as R2
21 22 23 24
import Reactix as R
import Reactix.DOM.HTML as H
import Routing.Hash (setHash)
import Toestand as T
25

James Laver's avatar
James Laver committed
26 27
here :: R2.Here
here = R2.here "Gargantext.Components.Nodes.Home"
28

James Laver's avatar
James Laver committed
29
newtype State = State { userName :: String, password :: String }
30

31
derive instance Newtype State _
32 33

initialState :: State
James Laver's avatar
James Laver committed
34
initialState = State { userName: "", password: "" }
35 36 37 38 39 40 41 42 43 44 45 46 47

data Action
  = Documentation
  | Enter
  | Login
  | SignUp

performAction :: Action -> Effect Unit
performAction Documentation = pure unit
performAction Enter = void $ setHash "/search"
performAction Login = void $ setHash "/login"
performAction SignUp = pure unit

48 49 50
langLandingData :: LandingLang -> LandingData
langLandingData LL_FR = Fr.landingData
langLandingData LL_EN = En.landingData
51 52 53

------------------------------------------------------------------------

54
type HomeProps =
55
  ( boxes     :: Boxes )
56

57
homeLayout :: R2.Leaf HomeProps
58
homeLayout = R2.leafComponent homeLayoutCpt
59
homeLayoutCpt :: R.Component HomeProps
James Laver's avatar
James Laver committed
60
homeLayoutCpt = here.component "homeLayout" cpt
61
  where
62
    cpt { boxes: boxes@{ backend
63
                       , lang
64 65
                       , sessions
                       , showLogin }
66
        } _ = do
67
      backend'  <- T.useLive T.unequal backend
James Laver's avatar
James Laver committed
68
      sessions' <- T.useLive T.unequal sessions
69 70
      lang'     <- T.useLive T.unequal lang
      let landingData = langLandingData lang'
James Laver's avatar
James Laver committed
71 72
      pure $
        H.span {}
arturo's avatar
arturo committed
73
        [ H.div { className: "home-title" }
James Laver's avatar
James Laver committed
74
          [ jumboTitle landingData ]
arturo's avatar
arturo committed
75
        , H.div { className: "home-research-form" } [] -- TODO
76
        , joinButtonOrTutorial boxes sessions' (click backend')
arturo's avatar
arturo committed
77
        , H.div { className: "home-public" }
James Laver's avatar
James Laver committed
78 79 80
          [ renderPublic { }
          , H.div { className:"col-12 d-flex justify-content-center" }
            [ H.h1 {} [ H.text "" ]] -- H.span {className: "fa fa-star-o"} []
arturo's avatar
arturo committed
81
          , H.div { className: "home-landing-data" }
James Laver's avatar
James Laver committed
82 83 84 85
            [ blocksRandomText' landingData ]
          , license
          ]
        ] where
86 87
        click mBackend _ =
          case mBackend of
88 89 90 91 92 93 94
            Nothing -> do
              mLoc <- Config.matchCurrentLocation
              case mLoc of
                Nothing -> pure unit
                Just b -> do
                  T.write_ (Just b) backend
                  T.write_ true showLogin
Alexandre Delanoë's avatar
Alexandre Delanoë committed
95
            Just _ -> T.write_ true showLogin
James Laver's avatar
James Laver committed
96

97
joinButtonOrTutorial :: forall e. Boxes
98 99 100
                     -> Sessions
                     -> (e -> Effect Unit)
                     -> R.Element
101
joinButtonOrTutorial boxes sessions click =
James Laver's avatar
James Laver committed
102 103
  if Sessions.null sessions
  then joinButton click
104
  else tutorial { boxes, sessions: Sessions.unSessions sessions }
105

James Laver's avatar
James Laver committed
106 107
joinButton :: forall e. (e -> Effect Unit) -> R.Element
joinButton click =
108 109
  -- TODO Add G.C.L.F.form -- which backend to use?
  -- form { backend, sessions, visible }
110 111
  H.div { className: divClass
        , style: { paddingTop: "100px", paddingBottom: "100px" } }
112
        [ H.button { className: buttonClass, title, on: { click } } [ H.text "Log in" ] ] where
James Laver's avatar
James Laver committed
113
    title = "Connect to the server"
114
    divClass = "flex-space-around d-flex justify-content-center"
115
    buttonClass = "btn btn-primary btn-lg btn-block"
James Laver's avatar
James Laver committed
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135

incompatible :: String
incompatible =
  "Sorry your browser is not compatible: use Firefox or Chromium instead."

video :: String -> R.Element
video fileDuration =
  H.div { className:"col-12 d-flex justify-content-center" }
  [ H.video
    { src, title, id, width: "900", type: "video/ogg", controls: true, muted: true }
    [ H.text incompatible ] ] where
      src = "http://dl.gargantext.org/" <> fileDuration
      title = "tutorial video here"
      id = "source_" <> fileDuration

data Tuto = Tuto { title :: String, id :: String, text  :: String }

summary :: R.Element
summary =
  H.div {}
136
  [ H.h3 {} [ H.text "Summary"]
James Laver's avatar
James Laver committed
137
  , H.ol {}
138
    [ sum "Getting Started for beginners" startTutos "alert-info"
James Laver's avatar
James Laver committed
139 140 141 142 143 144 145 146
    -- , sum "How to play (advanced users)?" playTutos "alert-warning"
    -- , sum "How to master (expert users)?" expertTutos "alert-danger"
    ]]
  where
    sum name tutos class' =
      H.div { className: "alert " <> class' }
      [ H.li {}
        [ H.h4 {} [ H.text name ]
147
        , H.ol {} (map toSummary tutos) ] ]
James Laver's avatar
James Laver committed
148 149
    toSummary (Tuto x) = H.li {} [ H.a {href: "#" <> x.id} [ H.text x.title ]]

150
type TutorialProps =
151 152
  ( boxes :: Boxes
  , sessions :: Array Session )
153 154

tutorial :: R2.Leaf TutorialProps
155
tutorial = R2.leafComponent tutorialCpt
156
tutorialCpt :: R.Component TutorialProps
157
tutorialCpt = here.component "tutorial" cpt where
158 159
  cpt { boxes
      , sessions } _ = do
160
    let folders = makeFolders sessions
161

arturo's avatar
arturo committed
162
    pure $ H.div { className: "mx-auto" }
163
      [ H.div {className: "d-flex justify-content-center"} [ H.div { className: "folders" } folders ]
164 165
      -- , H.h1 {} [H.text "Tutorials"]
      -- , summary
166 167
      -- , H.h3 {} [H.text "Resources"]
      -- , section "How to start?" "alert-info" startTutos
168 169 170 171
      -- , section "How to play?" "alert-warning" playTutos
      -- , section "How to master?" "alert-danger" expertTutos
      ]
    where
Alexandre Delanoë's avatar
Alexandre Delanoë committed
172
      {-
173 174 175 176 177
      section name class' tutos =
        H.div {} $ Array.cons (H.h4 {} [ H.text name ]) (map (makeTuto class') tutos)
      makeTuto class' (Tuto x) =
        H.div { className : "alert " <> class', id: x.id}
        [ video x.id, H.h4 {} [ H.text x.title ], H.p  {} [ H.text x.text ] ]
Alexandre Delanoë's avatar
Alexandre Delanoë committed
178
      -}
James Laver's avatar
James Laver committed
179

180
      makeFolders :: Array Session -> Array R.Element
181 182
      makeFolders s = sessionToFolder <$> s
        where
183
          sessionToFolder session@(Session {treeId, username, backend}) =
184 185
            H.span { className: "folder" } [
              H.div { className: "d-flex justify-content-center" } [ H.text (username <> "@" <> (cleanBackendUrl backend)) ]
186
            , H.div {} [ FV.folderView { boxes
187 188
                                       , nodeId: treeId
                                       , session } ] ]
189

James Laver's avatar
James Laver committed
190 191
startTutos :: Array Tuto
startTutos =
192
  [ Tuto { title: "The tree to manage your data"
James Laver's avatar
James Laver committed
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
         , id: "0_tree.ogv"
         , text : "The tree enables you to control all your actions. The Tree has typed nodes. Each node has some attributes and some methods which depend on its type. This specific ergonomy helps the memorization of all the complexity of the GarganTexts' features: hence you do not need to remember all the documentation! Just remember these simple axioms, the Tree is built with parent-children relations of nodes which have specific attributes and methods. To get its methods and attributes, just click on the wheel near its name (for this feature, see advanced tutorial: how to play with GarganText)." }
  -- ,  Tuto { title : "Edit your profile"
  --         , id    : "0_edit.ogv"
  --         , text  : "At the root of the tree, there is your user node, parent of all others nodes. Your profile is what others users will see or search for to reach you or to watch/follow your work. If you delete it you remove all your data from the specified instance, clear and simple." }
  , Tuto { title : "Discover the nodes of the tree"
         , id    : "0_nodes.ogv"
         , text  : "Under your user node you have 3 main nodes: private, shared and public nodes. Each node has its specific attributes and methods! Under private node, all your work is private only. Under shared folder you can create teams to invite your partners, students or colleagues. Under public node, you can publish your work with the world: hello word!" }
  -- , Tuto { title : "Read a corpus"
  --        , id    : "video_tutorial.mp4#t=43,79"
  --        , text  : "Each fresh corpus node has 4 children only: docs, list, board, graph. The docs node enable you to manage your documents and rate it. The list node let the user to manage its ngrams. The board node sum up your analysis with the main charts you made with your ngrams. The graph node let you explore your data in a new way. Others new type of nodes are coming such as Phylo node..." }
  -- , Tuto { title : "Manage your ngrams"
  --        , id    : "video_tutorial.mp4#t=80,214"
  --        , text  : "By default, 4 types of ngrams are created: Terms extracted from text fields such as title or abstract, Institutes are extracted from the Institute field of the metadata, Sources, Authors. In that tutorial, you will learn how to change the status of ngrams, group it or create new categories. Remember you need to save your work with the sycn button. Then the charts are updated after each sync. Your work is either synchronous or asynchronous: you can save locally your data, disconnect your device and sync when your Internet connection is back." }
  -- , Tuto { title : "Watch with the board"
  --        , id    : "video_tutorial.mp4#t=215,237"
  --        , text  : "Build your own watchboard! Easy. All your list enable you to have charts to follow the evolution of your corpus." }
  -- , Tuto { title : "Explore with the graph"
  --        , id    : "video_tutorial.mp4#t=238,293"
  --        , text  : "With the map terms you have selected already, the graph is built. 3 main panels can be hidden or shown to give you more visual space: tree, controls, side panel. The side panel shows the legend, the selected data and the community you are watching. You can link your corpus with a community (check nodes methods to do this)." }
  -- , Tuto { title : "Edit ngrams in your documents"
  --        , id    : "video_tutorial.mp4#t=294,312"
  --        , text  : "All selected ngrams can be updated in the document and they are autmatically updated in the lists." }
  ]
217

James Laver's avatar
James Laver committed
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
playTutos :: Array Tuto
playTutos = []
  -- [ Tuto { title : "Again the tree is your friend"
  --        , id    : "video_tutorial_1.mp4#t=,46"
  --        , text  : "At the right of each node, its wheel shows its attributes or enables the execution of its methods. Each type of node has different attributes and methods to help user in an ergonomic way." }
  -- , Tuto { title : "Build your analysis"
  --        , id    : "video_tutorial_1.mp4#t=47,146"
  --        , text  : "To build your analysis you need to create a corpus. Suppose you want to create it in your private folder in this tutorial. Use the wheel to execute any function on the corpus node in the tree. You can search the local database instance, the web or through apis connected to public databases. It becomes easy to add many documents to your dynamic corpus." }
  -- , Tuto { title : "Add documents with files and download your data"
  --        , id    : "video_tutorial_1.mp4#t=157,166"
  --        , text  : "You can add CSV files from Gargantext V3 legacy version: in your previous account, export your corpus and download it on your device. Then, upload it to v4 as CSV file." }
  -- , Tuto { title : "Move your corpus elsewhere in the tree"
  --        , id    : "video_tutorial_1.mp4#t=167,175"
  --        , text  : "Each node can be moved with this function. Move it in your team to share it. Remove it to unshare it. Some nodes can not be moved, it depends on the types methods." }
  -- , Tuto { title : "Rename your corpus"
  --        , id    : "video_tutorial_1.mp4#t=145,160"
  --        , text  : "Some nodes can be renamed, most of them. But you can not rename your User Node which is the root of the tree." }
  -- , Tuto { title : "Delete your corpus"
  --        , id    : "video_tutorial_1.mp4#t=179,182"
  --        , text  : "Each node can be deleted with its children." }
238
  -- ]
James Laver's avatar
James Laver committed
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275

expertTutos :: Array Tuto
expertTutos = []
  -- [ Tuto { title : "Share with a team and send invitations"
  --        , id    : "video_tutorial_2.mp4#t=,46"
  --        , text  : "[Link to update]" }
  -- , Tuto { title : "Multi instance connections"
  --        , id    : "video_tutorial_2.mp4#t=,46"
  --        , text  : "[Link to update]" }
  -- , Tuto { title : "Freeze a graph"
  --        , id    : "video_tutorial_2.mp4#t=,46"
  --        , text  : "[Link to update]" }
  -- , Tuto { title : "Publish"
  --        , id    : "video_tutorial_2.mp4#t=,46"
  --        , text  : "[Link to update]" }
  -- , Tuto { title : "Link a set of document (corpus) with a set of persons (community)"
  --        , id    : "video_tutorial_2.mp4#t=,46"
  --        , text  : "[Link to update]" }
  -- ,  Tuto { title : "Social lists: cumulative work made easy"
  --         , id    : "video_tutorial_2.mp4#t=,46"
  --         , text  : "[Link to update]" }
  -- ,  Tuto { title : "Data mining with calc"
  --         , id    : "video_tutorial_2.mp4#t=,46"
  --         , text  : "[Link to update]" }
  -- ,  Tuto { title : "Collaborative sync edition notes"
  --         , id    : "video_tutorial_2.mp4#t=,46"
  --         , text  : "[Link to update]" }
  -- ,  Tuto { title : "Coding with our notebooks"
  --         , id    : "video_tutorial_2.mp4#t=,46"
  --         , text  : "[Link to update]" }
  -- ,  Tuto { title : "Our api"
  --         , id    : "video_tutorial_2.mp4#t=,46"
  --         , text  : "[Link to update]" }
  -- ,  Tuto { title : "A tour in the code"
  --         , id    : "video_tutorial_2.mp4#t=,46"
  --         , text  : "[Link to update]" }
  -- ]
276 277 278 279 280 281 282 283 284 285 286 287 288

blocksRandomText' :: LandingData -> R.Element
blocksRandomText' (LandingData hd) = blocksRandomText hd.blockTexts

blocksRandomText :: BlockTexts -> R.Element
blocksRandomText (BlockTexts bt) =
  H.div { className: "row" } ( map showBlock bt.blocks )
  where
    showBlock :: BlockText -> R.Element
    showBlock (BlockText b) =
      H.div { className: "col-md-4 content" }
      [ H.h3 {}
        [ H.a { href: b.href, title: b.title}
James Laver's avatar
James Laver committed
289 290
          [ H.i { className: b.icon } []
          , H.text ("   " <> b.titleText) ]]
291
        , H.p {} [ H.text b.text ]
James Laver's avatar
James Laver committed
292
        , H.p {} [ docButton b.docButton ]]
293 294 295

docButton :: Button -> R.Element
docButton (Button b) =
James Laver's avatar
James Laver committed
296 297 298
  H.a { className, href: b.href, target: "blank", title: b.title }
  [ H.span { aria: { hidden: true }, className: "fa fa-hand-right" } []
  , H.text b.text ] where
299
    className = "btn btn-outline-secondary btn-sm spacing-class"
300

301 302
-- | TODO
-- <img src='logo.png' onmouseover="this.src='gargantextuel.png';" onmouseout="this.src='logo.png';" />
303 304
jumboTitle :: LandingData -> R.Element
jumboTitle (LandingData hd) =
James Laver's avatar
James Laver committed
305 306 307 308 309
  H.div {}
  [ H.div { className: "row" }
    [ H.div { className: "mx-auto" }
      [ H.div { id: "logo-designed" }
        [ H.img { src: "images/logo.png", title: hd.logoTitle } ]]]]
310

311
imageEnter :: forall t. LandingData -> t -> R.Element
312 313 314
imageEnter (LandingData hd) action =
  H.div {className: "row"}
  [ H.div {className: "col-md-offset-5 col-md-6 content"}
James Laver's avatar
James Laver committed
315 316
    [ H.img { src, action, id: "funnyimg", title: hd.imageTitle } ] ] where
      src = "images/Gargantextuel-212x300.jpg"