@@ -186,13 +186,21 @@ class (Functor m, Applicative m, Monad m, MonadError PandocError m)
187-- * Functions defined for all PandocMonad instances
187-- * Functions defined for all PandocMonad instances
189+-- | Set the verbosity level.
189setVerbosity :: PandocMonad m => Verbosity -> m ()
190setVerbosity :: PandocMonad m => Verbosity -> m ()
190setVerbosity verbosity =
191setVerbosity verbosity =
191 modifyCommonState $ \st -> st{ stVerbosity = verbosity }
192 modifyCommonState $ \st -> st{ stVerbosity = verbosity }
194+-- Get the accomulated log messages (in temporal order).
193getLog :: PandocMonad m => m [LogMessage]
195getLog :: PandocMonad m => m [LogMessage]
194getLog = reverse <$> getsCommonState stLog
196getLog = reverse <$> getsCommonState stLog
198+-- | Log a message using 'logOutput'. Note that
199+-- 'logOutput' is called only if the verbosity
200+-- level exceeds the level of the message, but
201+-- the message is added to the list of log messages
202+-- that will be retrieved by 'getLog' regardless
203+-- of its verbosity level.
196report :: PandocMonad m => LogMessage -> m ()
204report :: PandocMonad m => LogMessage -> m ()
197report msg = do
205report msg = do
198 verbosity <- getsCommonState stVerbosity
206 verbosity <- getsCommonState stVerbosity
@@ -200,9 +208,13 @@ report msg = do
200 when (level <= verbosity) $ logOutput msg
208 when (level <= verbosity) $ logOutput msg
201 modifyCommonState $ \st -> st{ stLog = msg : stLog st }
209 modifyCommonState $ \st -> st{ stLog = msg : stLog st }
211+-- | Determine whether tracing is enabled. This affects
212+-- the behavior of 'trace'. If tracing is not enabled,
213+-- 'trace' does nothing.
203setTrace :: PandocMonad m => Bool -> m ()
214setTrace :: PandocMonad m => Bool -> m ()
204setTrace useTracing = modifyCommonState $ \st -> st{stTrace = useTracing}
215setTrace useTracing = modifyCommonState $ \st -> st{stTrace = useTracing}
217+-- | Initialize the media bag.
206setMediaBag :: PandocMonad m => MediaBag -> m ()
218setMediaBag :: PandocMonad m => MediaBag -> m ()
207setMediaBag mb = modifyCommonState $ \st -> st{stMediaBag = mb}
219setMediaBag mb = modifyCommonState $ \st -> st{stMediaBag = mb}